iscsi_target_core.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891
  1. #ifndef ISCSI_TARGET_CORE_H
  2. #define ISCSI_TARGET_CORE_H
  3. #include <linux/in.h>
  4. #include <linux/configfs.h>
  5. #include <net/sock.h>
  6. #include <net/tcp.h>
  7. #include <scsi/scsi_cmnd.h>
  8. #include <scsi/iscsi_proto.h>
  9. #include <target/target_core_base.h>
  10. #define ISCSIT_VERSION "v4.1.0-rc2"
  11. #define ISCSI_MAX_DATASN_MISSING_COUNT 16
  12. #define ISCSI_TX_THREAD_TCP_TIMEOUT 2
  13. #define ISCSI_RX_THREAD_TCP_TIMEOUT 2
  14. #define SECONDS_FOR_ASYNC_LOGOUT 10
  15. #define SECONDS_FOR_ASYNC_TEXT 10
  16. #define SECONDS_FOR_LOGOUT_COMP 15
  17. #define WHITE_SPACE " \t\v\f\n\r"
  18. #define ISCSIT_MIN_TAGS 16
  19. #define ISCSIT_EXTRA_TAGS 8
  20. /* struct iscsi_node_attrib sanity values */
  21. #define NA_DATAOUT_TIMEOUT 3
  22. #define NA_DATAOUT_TIMEOUT_MAX 60
  23. #define NA_DATAOUT_TIMEOUT_MIX 2
  24. #define NA_DATAOUT_TIMEOUT_RETRIES 5
  25. #define NA_DATAOUT_TIMEOUT_RETRIES_MAX 15
  26. #define NA_DATAOUT_TIMEOUT_RETRIES_MIN 1
  27. #define NA_NOPIN_TIMEOUT 15
  28. #define NA_NOPIN_TIMEOUT_MAX 60
  29. #define NA_NOPIN_TIMEOUT_MIN 3
  30. #define NA_NOPIN_RESPONSE_TIMEOUT 30
  31. #define NA_NOPIN_RESPONSE_TIMEOUT_MAX 60
  32. #define NA_NOPIN_RESPONSE_TIMEOUT_MIN 3
  33. #define NA_RANDOM_DATAIN_PDU_OFFSETS 0
  34. #define NA_RANDOM_DATAIN_SEQ_OFFSETS 0
  35. #define NA_RANDOM_R2T_OFFSETS 0
  36. #define NA_DEFAULT_ERL 0
  37. #define NA_DEFAULT_ERL_MAX 2
  38. #define NA_DEFAULT_ERL_MIN 0
  39. /* struct iscsi_tpg_attrib sanity values */
  40. #define TA_AUTHENTICATION 1
  41. #define TA_LOGIN_TIMEOUT 15
  42. #define TA_LOGIN_TIMEOUT_MAX 30
  43. #define TA_LOGIN_TIMEOUT_MIN 5
  44. #define TA_NETIF_TIMEOUT 2
  45. #define TA_NETIF_TIMEOUT_MAX 15
  46. #define TA_NETIF_TIMEOUT_MIN 2
  47. #define TA_GENERATE_NODE_ACLS 0
  48. #define TA_DEFAULT_CMDSN_DEPTH 16
  49. #define TA_DEFAULT_CMDSN_DEPTH_MAX 512
  50. #define TA_DEFAULT_CMDSN_DEPTH_MIN 1
  51. #define TA_CACHE_DYNAMIC_ACLS 0
  52. /* Enabled by default in demo mode (generic_node_acls=1) */
  53. #define TA_DEMO_MODE_WRITE_PROTECT 1
  54. /* Disabled by default in production mode w/ explict ACLs */
  55. #define TA_PROD_MODE_WRITE_PROTECT 0
  56. #define TA_CACHE_CORE_NPS 0
  57. #define ISCSI_IOV_DATA_BUFFER 5
  58. enum iscsit_transport_type {
  59. ISCSI_TCP = 0,
  60. ISCSI_SCTP_TCP = 1,
  61. ISCSI_SCTP_UDP = 2,
  62. ISCSI_IWARP_TCP = 3,
  63. ISCSI_IWARP_SCTP = 4,
  64. ISCSI_INFINIBAND = 5,
  65. };
  66. /* RFC-3720 7.1.4 Standard Connection State Diagram for a Target */
  67. enum target_conn_state_table {
  68. TARG_CONN_STATE_FREE = 0x1,
  69. TARG_CONN_STATE_XPT_UP = 0x3,
  70. TARG_CONN_STATE_IN_LOGIN = 0x4,
  71. TARG_CONN_STATE_LOGGED_IN = 0x5,
  72. TARG_CONN_STATE_IN_LOGOUT = 0x6,
  73. TARG_CONN_STATE_LOGOUT_REQUESTED = 0x7,
  74. TARG_CONN_STATE_CLEANUP_WAIT = 0x8,
  75. };
  76. /* RFC-3720 7.3.2 Session State Diagram for a Target */
  77. enum target_sess_state_table {
  78. TARG_SESS_STATE_FREE = 0x1,
  79. TARG_SESS_STATE_ACTIVE = 0x2,
  80. TARG_SESS_STATE_LOGGED_IN = 0x3,
  81. TARG_SESS_STATE_FAILED = 0x4,
  82. TARG_SESS_STATE_IN_CONTINUE = 0x5,
  83. };
  84. /* struct iscsi_data_count->type */
  85. enum data_count_type {
  86. ISCSI_RX_DATA = 1,
  87. ISCSI_TX_DATA = 2,
  88. };
  89. /* struct iscsi_datain_req->dr_complete */
  90. enum datain_req_comp_table {
  91. DATAIN_COMPLETE_NORMAL = 1,
  92. DATAIN_COMPLETE_WITHIN_COMMAND_RECOVERY = 2,
  93. DATAIN_COMPLETE_CONNECTION_RECOVERY = 3,
  94. };
  95. /* struct iscsi_datain_req->recovery */
  96. enum datain_req_rec_table {
  97. DATAIN_WITHIN_COMMAND_RECOVERY = 1,
  98. DATAIN_CONNECTION_RECOVERY = 2,
  99. };
  100. /* struct iscsi_portal_group->state */
  101. enum tpg_state_table {
  102. TPG_STATE_FREE = 0,
  103. TPG_STATE_ACTIVE = 1,
  104. TPG_STATE_INACTIVE = 2,
  105. TPG_STATE_COLD_RESET = 3,
  106. };
  107. /* struct iscsi_tiqn->tiqn_state */
  108. enum tiqn_state_table {
  109. TIQN_STATE_ACTIVE = 1,
  110. TIQN_STATE_SHUTDOWN = 2,
  111. };
  112. /* struct iscsi_cmd->cmd_flags */
  113. enum cmd_flags_table {
  114. ICF_GOT_LAST_DATAOUT = 0x00000001,
  115. ICF_GOT_DATACK_SNACK = 0x00000002,
  116. ICF_NON_IMMEDIATE_UNSOLICITED_DATA = 0x00000004,
  117. ICF_SENT_LAST_R2T = 0x00000008,
  118. ICF_WITHIN_COMMAND_RECOVERY = 0x00000010,
  119. ICF_CONTIG_MEMORY = 0x00000020,
  120. ICF_ATTACHED_TO_RQUEUE = 0x00000040,
  121. ICF_OOO_CMDSN = 0x00000080,
  122. IFC_SENDTARGETS_ALL = 0x00000100,
  123. IFC_SENDTARGETS_SINGLE = 0x00000200,
  124. };
  125. /* struct iscsi_cmd->i_state */
  126. enum cmd_i_state_table {
  127. ISTATE_NO_STATE = 0,
  128. ISTATE_NEW_CMD = 1,
  129. ISTATE_DEFERRED_CMD = 2,
  130. ISTATE_UNSOLICITED_DATA = 3,
  131. ISTATE_RECEIVE_DATAOUT = 4,
  132. ISTATE_RECEIVE_DATAOUT_RECOVERY = 5,
  133. ISTATE_RECEIVED_LAST_DATAOUT = 6,
  134. ISTATE_WITHIN_DATAOUT_RECOVERY = 7,
  135. ISTATE_IN_CONNECTION_RECOVERY = 8,
  136. ISTATE_RECEIVED_TASKMGT = 9,
  137. ISTATE_SEND_ASYNCMSG = 10,
  138. ISTATE_SENT_ASYNCMSG = 11,
  139. ISTATE_SEND_DATAIN = 12,
  140. ISTATE_SEND_LAST_DATAIN = 13,
  141. ISTATE_SENT_LAST_DATAIN = 14,
  142. ISTATE_SEND_LOGOUTRSP = 15,
  143. ISTATE_SENT_LOGOUTRSP = 16,
  144. ISTATE_SEND_NOPIN = 17,
  145. ISTATE_SENT_NOPIN = 18,
  146. ISTATE_SEND_REJECT = 19,
  147. ISTATE_SENT_REJECT = 20,
  148. ISTATE_SEND_R2T = 21,
  149. ISTATE_SENT_R2T = 22,
  150. ISTATE_SEND_R2T_RECOVERY = 23,
  151. ISTATE_SENT_R2T_RECOVERY = 24,
  152. ISTATE_SEND_LAST_R2T = 25,
  153. ISTATE_SENT_LAST_R2T = 26,
  154. ISTATE_SEND_LAST_R2T_RECOVERY = 27,
  155. ISTATE_SENT_LAST_R2T_RECOVERY = 28,
  156. ISTATE_SEND_STATUS = 29,
  157. ISTATE_SEND_STATUS_BROKEN_PC = 30,
  158. ISTATE_SENT_STATUS = 31,
  159. ISTATE_SEND_STATUS_RECOVERY = 32,
  160. ISTATE_SENT_STATUS_RECOVERY = 33,
  161. ISTATE_SEND_TASKMGTRSP = 34,
  162. ISTATE_SENT_TASKMGTRSP = 35,
  163. ISTATE_SEND_TEXTRSP = 36,
  164. ISTATE_SENT_TEXTRSP = 37,
  165. ISTATE_SEND_NOPIN_WANT_RESPONSE = 38,
  166. ISTATE_SENT_NOPIN_WANT_RESPONSE = 39,
  167. ISTATE_SEND_NOPIN_NO_RESPONSE = 40,
  168. ISTATE_REMOVE = 41,
  169. ISTATE_FREE = 42,
  170. };
  171. /* Used for iscsi_recover_cmdsn() return values */
  172. enum recover_cmdsn_ret_table {
  173. CMDSN_ERROR_CANNOT_RECOVER = -1,
  174. CMDSN_NORMAL_OPERATION = 0,
  175. CMDSN_LOWER_THAN_EXP = 1,
  176. CMDSN_HIGHER_THAN_EXP = 2,
  177. };
  178. /* Used for iscsi_handle_immediate_data() return values */
  179. enum immedate_data_ret_table {
  180. IMMEDIATE_DATA_CANNOT_RECOVER = -1,
  181. IMMEDIATE_DATA_NORMAL_OPERATION = 0,
  182. IMMEDIATE_DATA_ERL1_CRC_FAILURE = 1,
  183. };
  184. /* Used for iscsi_decide_dataout_action() return values */
  185. enum dataout_action_ret_table {
  186. DATAOUT_CANNOT_RECOVER = -1,
  187. DATAOUT_NORMAL = 0,
  188. DATAOUT_SEND_R2T = 1,
  189. DATAOUT_SEND_TO_TRANSPORT = 2,
  190. DATAOUT_WITHIN_COMMAND_RECOVERY = 3,
  191. };
  192. /* Used for struct iscsi_node_auth->naf_flags */
  193. enum naf_flags_table {
  194. NAF_USERID_SET = 0x01,
  195. NAF_PASSWORD_SET = 0x02,
  196. NAF_USERID_IN_SET = 0x04,
  197. NAF_PASSWORD_IN_SET = 0x08,
  198. };
  199. /* Used by various struct timer_list to manage iSCSI specific state */
  200. enum iscsi_timer_flags_table {
  201. ISCSI_TF_RUNNING = 0x01,
  202. ISCSI_TF_STOP = 0x02,
  203. ISCSI_TF_EXPIRED = 0x04,
  204. };
  205. /* Used for struct iscsi_np->np_flags */
  206. enum np_flags_table {
  207. NPF_IP_NETWORK = 0x00,
  208. };
  209. /* Used for struct iscsi_np->np_thread_state */
  210. enum np_thread_state_table {
  211. ISCSI_NP_THREAD_ACTIVE = 1,
  212. ISCSI_NP_THREAD_INACTIVE = 2,
  213. ISCSI_NP_THREAD_RESET = 3,
  214. ISCSI_NP_THREAD_SHUTDOWN = 4,
  215. ISCSI_NP_THREAD_EXIT = 5,
  216. };
  217. struct iscsi_conn_ops {
  218. u8 HeaderDigest; /* [0,1] == [None,CRC32C] */
  219. u8 DataDigest; /* [0,1] == [None,CRC32C] */
  220. u32 MaxRecvDataSegmentLength; /* [512..2**24-1] */
  221. u32 MaxXmitDataSegmentLength; /* [512..2**24-1] */
  222. u8 OFMarker; /* [0,1] == [No,Yes] */
  223. u8 IFMarker; /* [0,1] == [No,Yes] */
  224. u32 OFMarkInt; /* [1..65535] */
  225. u32 IFMarkInt; /* [1..65535] */
  226. /*
  227. * iSER specific connection parameters
  228. */
  229. u32 InitiatorRecvDataSegmentLength; /* [512..2**24-1] */
  230. u32 TargetRecvDataSegmentLength; /* [512..2**24-1] */
  231. };
  232. struct iscsi_sess_ops {
  233. char InitiatorName[224];
  234. char InitiatorAlias[256];
  235. char TargetName[224];
  236. char TargetAlias[256];
  237. char TargetAddress[256];
  238. u16 TargetPortalGroupTag; /* [0..65535] */
  239. u16 MaxConnections; /* [1..65535] */
  240. u8 InitialR2T; /* [0,1] == [No,Yes] */
  241. u8 ImmediateData; /* [0,1] == [No,Yes] */
  242. u32 MaxBurstLength; /* [512..2**24-1] */
  243. u32 FirstBurstLength; /* [512..2**24-1] */
  244. u16 DefaultTime2Wait; /* [0..3600] */
  245. u16 DefaultTime2Retain; /* [0..3600] */
  246. u16 MaxOutstandingR2T; /* [1..65535] */
  247. u8 DataPDUInOrder; /* [0,1] == [No,Yes] */
  248. u8 DataSequenceInOrder; /* [0,1] == [No,Yes] */
  249. u8 ErrorRecoveryLevel; /* [0..2] */
  250. u8 SessionType; /* [0,1] == [Normal,Discovery]*/
  251. /*
  252. * iSER specific session parameters
  253. */
  254. u8 RDMAExtensions; /* [0,1] == [No,Yes] */
  255. };
  256. struct iscsi_queue_req {
  257. int state;
  258. struct iscsi_cmd *cmd;
  259. struct list_head qr_list;
  260. };
  261. struct iscsi_data_count {
  262. int data_length;
  263. int sync_and_steering;
  264. enum data_count_type type;
  265. u32 iov_count;
  266. u32 ss_iov_count;
  267. u32 ss_marker_count;
  268. struct kvec *iov;
  269. };
  270. struct iscsi_param_list {
  271. bool iser;
  272. struct list_head param_list;
  273. struct list_head extra_response_list;
  274. };
  275. struct iscsi_datain_req {
  276. enum datain_req_comp_table dr_complete;
  277. int generate_recovery_values;
  278. enum datain_req_rec_table recovery;
  279. u32 begrun;
  280. u32 runlength;
  281. u32 data_length;
  282. u32 data_offset;
  283. u32 data_sn;
  284. u32 next_burst_len;
  285. u32 read_data_done;
  286. u32 seq_send_order;
  287. struct list_head cmd_datain_node;
  288. } ____cacheline_aligned;
  289. struct iscsi_ooo_cmdsn {
  290. u16 cid;
  291. u32 batch_count;
  292. u32 cmdsn;
  293. u32 exp_cmdsn;
  294. struct iscsi_cmd *cmd;
  295. struct list_head ooo_list;
  296. } ____cacheline_aligned;
  297. struct iscsi_datain {
  298. u8 flags;
  299. u32 data_sn;
  300. u32 length;
  301. u32 offset;
  302. } ____cacheline_aligned;
  303. struct iscsi_r2t {
  304. int seq_complete;
  305. int recovery_r2t;
  306. int sent_r2t;
  307. u32 r2t_sn;
  308. u32 offset;
  309. u32 targ_xfer_tag;
  310. u32 xfer_len;
  311. struct list_head r2t_list;
  312. } ____cacheline_aligned;
  313. struct iscsi_cmd {
  314. enum iscsi_timer_flags_table dataout_timer_flags;
  315. /* DataOUT timeout retries */
  316. u8 dataout_timeout_retries;
  317. /* Within command recovery count */
  318. u8 error_recovery_count;
  319. /* iSCSI dependent state for out or order CmdSNs */
  320. enum cmd_i_state_table deferred_i_state;
  321. /* iSCSI dependent state */
  322. enum cmd_i_state_table i_state;
  323. /* Command is an immediate command (ISCSI_OP_IMMEDIATE set) */
  324. u8 immediate_cmd;
  325. /* Immediate data present */
  326. u8 immediate_data;
  327. /* iSCSI Opcode */
  328. u8 iscsi_opcode;
  329. /* iSCSI Response Code */
  330. u8 iscsi_response;
  331. /* Logout reason when iscsi_opcode == ISCSI_INIT_LOGOUT_CMND */
  332. u8 logout_reason;
  333. /* Logout response code when iscsi_opcode == ISCSI_INIT_LOGOUT_CMND */
  334. u8 logout_response;
  335. /* MaxCmdSN has been incremented */
  336. u8 maxcmdsn_inc;
  337. /* Immediate Unsolicited Dataout */
  338. u8 unsolicited_data;
  339. /* Reject reason code */
  340. u8 reject_reason;
  341. /* CID contained in logout PDU when opcode == ISCSI_INIT_LOGOUT_CMND */
  342. u16 logout_cid;
  343. /* Command flags */
  344. enum cmd_flags_table cmd_flags;
  345. /* Initiator Task Tag assigned from Initiator */
  346. itt_t init_task_tag;
  347. /* Target Transfer Tag assigned from Target */
  348. u32 targ_xfer_tag;
  349. /* CmdSN assigned from Initiator */
  350. u32 cmd_sn;
  351. /* ExpStatSN assigned from Initiator */
  352. u32 exp_stat_sn;
  353. /* StatSN assigned to this ITT */
  354. u32 stat_sn;
  355. /* DataSN Counter */
  356. u32 data_sn;
  357. /* R2TSN Counter */
  358. u32 r2t_sn;
  359. /* Last DataSN acknowledged via DataAck SNACK */
  360. u32 acked_data_sn;
  361. /* Used for echoing NOPOUT ping data */
  362. u32 buf_ptr_size;
  363. /* Used to store DataDigest */
  364. u32 data_crc;
  365. /* Counter for MaxOutstandingR2T */
  366. u32 outstanding_r2ts;
  367. /* Next R2T Offset when DataSequenceInOrder=Yes */
  368. u32 r2t_offset;
  369. /* Iovec current and orig count for iscsi_cmd->iov_data */
  370. u32 iov_data_count;
  371. u32 orig_iov_data_count;
  372. /* Number of miscellaneous iovecs used for IP stack calls */
  373. u32 iov_misc_count;
  374. /* Number of struct iscsi_pdu in struct iscsi_cmd->pdu_list */
  375. u32 pdu_count;
  376. /* Next struct iscsi_pdu to send in struct iscsi_cmd->pdu_list */
  377. u32 pdu_send_order;
  378. /* Current struct iscsi_pdu in struct iscsi_cmd->pdu_list */
  379. u32 pdu_start;
  380. /* Next struct iscsi_seq to send in struct iscsi_cmd->seq_list */
  381. u32 seq_send_order;
  382. /* Number of struct iscsi_seq in struct iscsi_cmd->seq_list */
  383. u32 seq_count;
  384. /* Current struct iscsi_seq in struct iscsi_cmd->seq_list */
  385. u32 seq_no;
  386. /* Lowest offset in current DataOUT sequence */
  387. u32 seq_start_offset;
  388. /* Highest offset in current DataOUT sequence */
  389. u32 seq_end_offset;
  390. /* Total size in bytes received so far of READ data */
  391. u32 read_data_done;
  392. /* Total size in bytes received so far of WRITE data */
  393. u32 write_data_done;
  394. /* Counter for FirstBurstLength key */
  395. u32 first_burst_len;
  396. /* Counter for MaxBurstLength key */
  397. u32 next_burst_len;
  398. /* Transfer size used for IP stack calls */
  399. u32 tx_size;
  400. /* Buffer used for various purposes */
  401. void *buf_ptr;
  402. /* Used by SendTargets=[iqn.,eui.] discovery */
  403. void *text_in_ptr;
  404. /* See include/linux/dma-mapping.h */
  405. enum dma_data_direction data_direction;
  406. /* iSCSI PDU Header + CRC */
  407. unsigned char pdu[ISCSI_HDR_LEN + ISCSI_CRC_LEN];
  408. /* Number of times struct iscsi_cmd is present in immediate queue */
  409. atomic_t immed_queue_count;
  410. atomic_t response_queue_count;
  411. spinlock_t datain_lock;
  412. spinlock_t dataout_timeout_lock;
  413. /* spinlock for protecting struct iscsi_cmd->i_state */
  414. spinlock_t istate_lock;
  415. /* spinlock for adding within command recovery entries */
  416. spinlock_t error_lock;
  417. /* spinlock for adding R2Ts */
  418. spinlock_t r2t_lock;
  419. /* DataIN List */
  420. struct list_head datain_list;
  421. /* R2T List */
  422. struct list_head cmd_r2t_list;
  423. /* Timer for DataOUT */
  424. struct timer_list dataout_timer;
  425. /* Iovecs for SCSI data payload RX/TX w/ kernel level sockets */
  426. struct kvec *iov_data;
  427. /* Iovecs for miscellaneous purposes */
  428. #define ISCSI_MISC_IOVECS 5
  429. struct kvec iov_misc[ISCSI_MISC_IOVECS];
  430. /* Array of struct iscsi_pdu used for DataPDUInOrder=No */
  431. struct iscsi_pdu *pdu_list;
  432. /* Current struct iscsi_pdu used for DataPDUInOrder=No */
  433. struct iscsi_pdu *pdu_ptr;
  434. /* Array of struct iscsi_seq used for DataSequenceInOrder=No */
  435. struct iscsi_seq *seq_list;
  436. /* Current struct iscsi_seq used for DataSequenceInOrder=No */
  437. struct iscsi_seq *seq_ptr;
  438. /* TMR Request when iscsi_opcode == ISCSI_OP_SCSI_TMFUNC */
  439. struct iscsi_tmr_req *tmr_req;
  440. /* Connection this command is alligient to */
  441. struct iscsi_conn *conn;
  442. /* Pointer to connection recovery entry */
  443. struct iscsi_conn_recovery *cr;
  444. /* Session the command is part of, used for connection recovery */
  445. struct iscsi_session *sess;
  446. /* list_head for connection list */
  447. struct list_head i_conn_node;
  448. /* The TCM I/O descriptor that is accessed via container_of() */
  449. struct se_cmd se_cmd;
  450. /* Sense buffer that will be mapped into outgoing status */
  451. #define ISCSI_SENSE_BUFFER_LEN (TRANSPORT_SENSE_BUFFER + 2)
  452. unsigned char sense_buffer[ISCSI_SENSE_BUFFER_LEN];
  453. u32 padding;
  454. u8 pad_bytes[4];
  455. struct scatterlist *first_data_sg;
  456. u32 first_data_sg_off;
  457. u32 kmapped_nents;
  458. sense_reason_t sense_reason;
  459. } ____cacheline_aligned;
  460. struct iscsi_tmr_req {
  461. bool task_reassign:1;
  462. u32 exp_data_sn;
  463. struct iscsi_cmd *ref_cmd;
  464. struct iscsi_conn_recovery *conn_recovery;
  465. struct se_tmr_req *se_tmr_req;
  466. };
  467. struct iscsi_conn {
  468. wait_queue_head_t queues_wq;
  469. /* Authentication Successful for this connection */
  470. u8 auth_complete;
  471. /* State connection is currently in */
  472. u8 conn_state;
  473. u8 conn_logout_reason;
  474. u8 network_transport;
  475. enum iscsi_timer_flags_table nopin_timer_flags;
  476. enum iscsi_timer_flags_table nopin_response_timer_flags;
  477. /* Used to know what thread encountered a transport failure */
  478. u8 which_thread;
  479. /* connection id assigned by the Initiator */
  480. u16 cid;
  481. /* Remote TCP Port */
  482. u16 login_port;
  483. u16 local_port;
  484. int net_size;
  485. int login_family;
  486. u32 auth_id;
  487. u32 conn_flags;
  488. /* Used for iscsi_tx_login_rsp() */
  489. itt_t login_itt;
  490. u32 exp_statsn;
  491. /* Per connection status sequence number */
  492. u32 stat_sn;
  493. /* IFMarkInt's Current Value */
  494. u32 if_marker;
  495. /* OFMarkInt's Current Value */
  496. u32 of_marker;
  497. /* Used for calculating OFMarker offset to next PDU */
  498. u32 of_marker_offset;
  499. #define IPV6_ADDRESS_SPACE 48
  500. unsigned char login_ip[IPV6_ADDRESS_SPACE];
  501. unsigned char local_ip[IPV6_ADDRESS_SPACE];
  502. int conn_usage_count;
  503. int conn_waiting_on_uc;
  504. atomic_t check_immediate_queue;
  505. atomic_t conn_logout_remove;
  506. atomic_t connection_exit;
  507. atomic_t connection_recovery;
  508. atomic_t connection_reinstatement;
  509. atomic_t connection_wait_rcfr;
  510. atomic_t sleep_on_conn_wait_comp;
  511. atomic_t transport_failed;
  512. struct completion conn_post_wait_comp;
  513. struct completion conn_wait_comp;
  514. struct completion conn_wait_rcfr_comp;
  515. struct completion conn_waiting_on_uc_comp;
  516. struct completion conn_logout_comp;
  517. struct completion tx_half_close_comp;
  518. struct completion rx_half_close_comp;
  519. /* socket used by this connection */
  520. struct socket *sock;
  521. void (*orig_data_ready)(struct sock *, int);
  522. void (*orig_state_change)(struct sock *);
  523. #define LOGIN_FLAGS_READ_ACTIVE 1
  524. #define LOGIN_FLAGS_CLOSED 2
  525. #define LOGIN_FLAGS_READY 4
  526. unsigned long login_flags;
  527. struct delayed_work login_work;
  528. struct delayed_work login_cleanup_work;
  529. struct iscsi_login *login;
  530. struct timer_list nopin_timer;
  531. struct timer_list nopin_response_timer;
  532. struct timer_list transport_timer;
  533. struct task_struct *login_kworker;
  534. /* Spinlock used for add/deleting cmd's from conn_cmd_list */
  535. spinlock_t cmd_lock;
  536. spinlock_t conn_usage_lock;
  537. spinlock_t immed_queue_lock;
  538. spinlock_t nopin_timer_lock;
  539. spinlock_t response_queue_lock;
  540. spinlock_t state_lock;
  541. /* libcrypto RX and TX contexts for crc32c */
  542. struct hash_desc conn_rx_hash;
  543. struct hash_desc conn_tx_hash;
  544. /* Used for scheduling TX and RX connection kthreads */
  545. cpumask_var_t conn_cpumask;
  546. unsigned int conn_rx_reset_cpumask:1;
  547. unsigned int conn_tx_reset_cpumask:1;
  548. /* list_head of struct iscsi_cmd for this connection */
  549. struct list_head conn_cmd_list;
  550. struct list_head immed_queue_list;
  551. struct list_head response_queue_list;
  552. struct iscsi_conn_ops *conn_ops;
  553. struct iscsi_login *conn_login;
  554. struct iscsit_transport *conn_transport;
  555. struct iscsi_param_list *param_list;
  556. /* Used for per connection auth state machine */
  557. void *auth_protocol;
  558. void *context;
  559. struct iscsi_login_thread_s *login_thread;
  560. struct iscsi_portal_group *tpg;
  561. struct iscsi_tpg_np *tpg_np;
  562. /* Pointer to parent session */
  563. struct iscsi_session *sess;
  564. /* Pointer to thread_set in use for this conn's threads */
  565. struct iscsi_thread_set *thread_set;
  566. /* list_head for session connection list */
  567. struct list_head conn_list;
  568. } ____cacheline_aligned;
  569. struct iscsi_conn_recovery {
  570. u16 cid;
  571. u32 cmd_count;
  572. u32 maxrecvdatasegmentlength;
  573. u32 maxxmitdatasegmentlength;
  574. int ready_for_reallegiance;
  575. struct list_head conn_recovery_cmd_list;
  576. spinlock_t conn_recovery_cmd_lock;
  577. struct timer_list time2retain_timer;
  578. struct iscsi_session *sess;
  579. struct list_head cr_list;
  580. } ____cacheline_aligned;
  581. struct iscsi_session {
  582. u8 initiator_vendor;
  583. u8 isid[6];
  584. enum iscsi_timer_flags_table time2retain_timer_flags;
  585. u8 version_active;
  586. u16 cid_called;
  587. u16 conn_recovery_count;
  588. u16 tsih;
  589. /* state session is currently in */
  590. u32 session_state;
  591. /* session wide counter: initiator assigned task tag */
  592. itt_t init_task_tag;
  593. /* session wide counter: target assigned task tag */
  594. u32 targ_xfer_tag;
  595. u32 cmdsn_window;
  596. /* protects cmdsn values */
  597. struct mutex cmdsn_mutex;
  598. /* session wide counter: expected command sequence number */
  599. u32 exp_cmd_sn;
  600. /* session wide counter: maximum allowed command sequence number */
  601. u32 max_cmd_sn;
  602. struct list_head sess_ooo_cmdsn_list;
  603. /* LIO specific session ID */
  604. u32 sid;
  605. char auth_type[8];
  606. /* unique within the target */
  607. int session_index;
  608. /* Used for session reference counting */
  609. int session_usage_count;
  610. int session_waiting_on_uc;
  611. u32 cmd_pdus;
  612. u32 rsp_pdus;
  613. u64 tx_data_octets;
  614. u64 rx_data_octets;
  615. u32 conn_digest_errors;
  616. u32 conn_timeout_errors;
  617. u64 creation_time;
  618. spinlock_t session_stats_lock;
  619. /* Number of active connections */
  620. atomic_t nconn;
  621. atomic_t session_continuation;
  622. atomic_t session_fall_back_to_erl0;
  623. atomic_t session_logout;
  624. atomic_t session_reinstatement;
  625. atomic_t session_stop_active;
  626. atomic_t sleep_on_sess_wait_comp;
  627. /* connection list */
  628. struct list_head sess_conn_list;
  629. struct list_head cr_active_list;
  630. struct list_head cr_inactive_list;
  631. spinlock_t conn_lock;
  632. spinlock_t cr_a_lock;
  633. spinlock_t cr_i_lock;
  634. spinlock_t session_usage_lock;
  635. spinlock_t ttt_lock;
  636. struct completion async_msg_comp;
  637. struct completion reinstatement_comp;
  638. struct completion session_wait_comp;
  639. struct completion session_waiting_on_uc_comp;
  640. struct timer_list time2retain_timer;
  641. struct iscsi_sess_ops *sess_ops;
  642. struct se_session *se_sess;
  643. struct iscsi_portal_group *tpg;
  644. } ____cacheline_aligned;
  645. struct iscsi_login {
  646. u8 auth_complete;
  647. u8 checked_for_existing;
  648. u8 current_stage;
  649. u8 leading_connection;
  650. u8 first_request;
  651. u8 version_min;
  652. u8 version_max;
  653. u8 login_complete;
  654. u8 login_failed;
  655. bool zero_tsih;
  656. char isid[6];
  657. u32 cmd_sn;
  658. itt_t init_task_tag;
  659. u32 initial_exp_statsn;
  660. u32 rsp_length;
  661. u16 cid;
  662. u16 tsih;
  663. char req[ISCSI_HDR_LEN];
  664. char rsp[ISCSI_HDR_LEN];
  665. char *req_buf;
  666. char *rsp_buf;
  667. struct iscsi_conn *conn;
  668. struct iscsi_np *np;
  669. } ____cacheline_aligned;
  670. struct iscsi_node_attrib {
  671. u32 dataout_timeout;
  672. u32 dataout_timeout_retries;
  673. u32 default_erl;
  674. u32 nopin_timeout;
  675. u32 nopin_response_timeout;
  676. u32 random_datain_pdu_offsets;
  677. u32 random_datain_seq_offsets;
  678. u32 random_r2t_offsets;
  679. u32 tmr_cold_reset;
  680. u32 tmr_warm_reset;
  681. struct iscsi_node_acl *nacl;
  682. };
  683. struct se_dev_entry_s;
  684. struct iscsi_node_auth {
  685. enum naf_flags_table naf_flags;
  686. int authenticate_target;
  687. /* Used for iscsit_global->discovery_auth,
  688. * set to zero (auth disabled) by default */
  689. int enforce_discovery_auth;
  690. #define MAX_USER_LEN 256
  691. #define MAX_PASS_LEN 256
  692. char userid[MAX_USER_LEN];
  693. char password[MAX_PASS_LEN];
  694. char userid_mutual[MAX_USER_LEN];
  695. char password_mutual[MAX_PASS_LEN];
  696. };
  697. #include "iscsi_target_stat.h"
  698. struct iscsi_node_stat_grps {
  699. struct config_group iscsi_sess_stats_group;
  700. struct config_group iscsi_conn_stats_group;
  701. };
  702. struct iscsi_node_acl {
  703. struct iscsi_node_attrib node_attrib;
  704. struct iscsi_node_auth node_auth;
  705. struct iscsi_node_stat_grps node_stat_grps;
  706. struct se_node_acl se_node_acl;
  707. };
  708. #define NODE_STAT_GRPS(nacl) (&(nacl)->node_stat_grps)
  709. #define ISCSI_NODE_ATTRIB(t) (&(t)->node_attrib)
  710. #define ISCSI_NODE_AUTH(t) (&(t)->node_auth)
  711. struct iscsi_tpg_attrib {
  712. u32 authentication;
  713. u32 login_timeout;
  714. u32 netif_timeout;
  715. u32 generate_node_acls;
  716. u32 cache_dynamic_acls;
  717. u32 default_cmdsn_depth;
  718. u32 demo_mode_write_protect;
  719. u32 prod_mode_write_protect;
  720. struct iscsi_portal_group *tpg;
  721. };
  722. struct iscsi_np {
  723. int np_network_transport;
  724. int np_ip_proto;
  725. int np_sock_type;
  726. enum np_thread_state_table np_thread_state;
  727. enum iscsi_timer_flags_table np_login_timer_flags;
  728. u32 np_exports;
  729. enum np_flags_table np_flags;
  730. unsigned char np_ip[IPV6_ADDRESS_SPACE];
  731. u16 np_port;
  732. spinlock_t np_thread_lock;
  733. struct completion np_restart_comp;
  734. struct socket *np_socket;
  735. struct __kernel_sockaddr_storage np_sockaddr;
  736. struct task_struct *np_thread;
  737. struct timer_list np_login_timer;
  738. void *np_context;
  739. struct iscsit_transport *np_transport;
  740. struct list_head np_list;
  741. } ____cacheline_aligned;
  742. struct iscsi_tpg_np {
  743. struct iscsi_np *tpg_np;
  744. struct iscsi_portal_group *tpg;
  745. struct iscsi_tpg_np *tpg_np_parent;
  746. struct list_head tpg_np_list;
  747. struct list_head tpg_np_child_list;
  748. struct list_head tpg_np_parent_list;
  749. struct se_tpg_np se_tpg_np;
  750. spinlock_t tpg_np_parent_lock;
  751. struct completion tpg_np_comp;
  752. struct kref tpg_np_kref;
  753. };
  754. struct iscsi_portal_group {
  755. unsigned char tpg_chap_id;
  756. /* TPG State */
  757. enum tpg_state_table tpg_state;
  758. /* Target Portal Group Tag */
  759. u16 tpgt;
  760. /* Id assigned to target sessions */
  761. u16 ntsih;
  762. /* Number of active sessions */
  763. u32 nsessions;
  764. /* Number of Network Portals available for this TPG */
  765. u32 num_tpg_nps;
  766. /* Per TPG LIO specific session ID. */
  767. u32 sid;
  768. /* Spinlock for adding/removing Network Portals */
  769. spinlock_t tpg_np_lock;
  770. spinlock_t tpg_state_lock;
  771. struct se_portal_group tpg_se_tpg;
  772. struct mutex tpg_access_lock;
  773. struct semaphore np_login_sem;
  774. struct iscsi_tpg_attrib tpg_attrib;
  775. struct iscsi_node_auth tpg_demo_auth;
  776. /* Pointer to default list of iSCSI parameters for TPG */
  777. struct iscsi_param_list *param_list;
  778. struct iscsi_tiqn *tpg_tiqn;
  779. struct list_head tpg_gnp_list;
  780. struct list_head tpg_list;
  781. } ____cacheline_aligned;
  782. #define ISCSI_TPG_C(c) ((struct iscsi_portal_group *)(c)->tpg)
  783. #define ISCSI_TPG_LUN(c, l) ((iscsi_tpg_list_t *)(c)->tpg->tpg_lun_list_t[l])
  784. #define ISCSI_TPG_S(s) ((struct iscsi_portal_group *)(s)->tpg)
  785. #define ISCSI_TPG_ATTRIB(t) (&(t)->tpg_attrib)
  786. #define SE_TPG(tpg) (&(tpg)->tpg_se_tpg)
  787. struct iscsi_wwn_stat_grps {
  788. struct config_group iscsi_stat_group;
  789. struct config_group iscsi_instance_group;
  790. struct config_group iscsi_sess_err_group;
  791. struct config_group iscsi_tgt_attr_group;
  792. struct config_group iscsi_login_stats_group;
  793. struct config_group iscsi_logout_stats_group;
  794. };
  795. struct iscsi_tiqn {
  796. #define ISCSI_IQN_LEN 224
  797. unsigned char tiqn[ISCSI_IQN_LEN];
  798. enum tiqn_state_table tiqn_state;
  799. int tiqn_access_count;
  800. u32 tiqn_active_tpgs;
  801. u32 tiqn_ntpgs;
  802. u32 tiqn_num_tpg_nps;
  803. u32 tiqn_nsessions;
  804. struct list_head tiqn_list;
  805. struct list_head tiqn_tpg_list;
  806. spinlock_t tiqn_state_lock;
  807. spinlock_t tiqn_tpg_lock;
  808. struct se_wwn tiqn_wwn;
  809. struct iscsi_wwn_stat_grps tiqn_stat_grps;
  810. int tiqn_index;
  811. struct iscsi_sess_err_stats sess_err_stats;
  812. struct iscsi_login_stats login_stats;
  813. struct iscsi_logout_stats logout_stats;
  814. } ____cacheline_aligned;
  815. #define WWN_STAT_GRPS(tiqn) (&(tiqn)->tiqn_stat_grps)
  816. struct iscsit_global {
  817. /* In core shutdown */
  818. u32 in_shutdown;
  819. u32 active_ts;
  820. /* Unique identifier used for the authentication daemon */
  821. u32 auth_id;
  822. u32 inactive_ts;
  823. /* Thread Set bitmap count */
  824. int ts_bitmap_count;
  825. /* Thread Set bitmap pointer */
  826. unsigned long *ts_bitmap;
  827. /* Used for iSCSI discovery session authentication */
  828. struct iscsi_node_acl discovery_acl;
  829. struct iscsi_portal_group *discovery_tpg;
  830. };
  831. #endif /* ISCSI_TARGET_CORE_H */