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