iscsi_target_core.h 25 KB

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