xref: /linux/include/target/iscsi/iscsi_target_core.h (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732) 
1 #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/iscsi_proto.h>
9 #include <target/target_core_base.h>
10 
11 #define ISCSIT_VERSION			"v4.1.0"
12 #define ISCSI_MAX_DATASN_MISSING_COUNT	16
13 #define ISCSI_TX_THREAD_TCP_TIMEOUT	2
14 #define ISCSI_RX_THREAD_TCP_TIMEOUT	2
15 #define SECONDS_FOR_ASYNC_LOGOUT	10
16 #define SECONDS_FOR_ASYNC_TEXT		10
17 #define SECONDS_FOR_LOGOUT_COMP		15
18 #define WHITE_SPACE			" \t\v\f\n\r"
19 #define ISCSIT_MIN_TAGS			16
20 #define ISCSIT_EXTRA_TAGS		8
21 #define ISCSIT_TCP_BACKLOG		256
22 #define ISCSI_RX_THREAD_NAME		"iscsi_trx"
23 #define ISCSI_TX_THREAD_NAME		"iscsi_ttx"
24 
25 /* struct iscsi_node_attrib sanity values */
26 #define NA_DATAOUT_TIMEOUT		3
27 #define NA_DATAOUT_TIMEOUT_MAX		60
28 #define NA_DATAOUT_TIMEOUT_MIX		2
29 #define NA_DATAOUT_TIMEOUT_RETRIES	5
30 #define NA_DATAOUT_TIMEOUT_RETRIES_MAX	15
31 #define NA_DATAOUT_TIMEOUT_RETRIES_MIN	1
32 #define NA_NOPIN_TIMEOUT		15
33 #define NA_NOPIN_TIMEOUT_MAX		60
34 #define NA_NOPIN_TIMEOUT_MIN		3
35 #define NA_NOPIN_RESPONSE_TIMEOUT	30
36 #define NA_NOPIN_RESPONSE_TIMEOUT_MAX	60
37 #define NA_NOPIN_RESPONSE_TIMEOUT_MIN	3
38 #define NA_RANDOM_DATAIN_PDU_OFFSETS	0
39 #define NA_RANDOM_DATAIN_SEQ_OFFSETS	0
40 #define NA_RANDOM_R2T_OFFSETS		0
41 
42 /* struct iscsi_tpg_attrib sanity values */
43 #define TA_AUTHENTICATION		1
44 #define TA_LOGIN_TIMEOUT		15
45 #define TA_LOGIN_TIMEOUT_MAX		30
46 #define TA_LOGIN_TIMEOUT_MIN		5
47 #define TA_NETIF_TIMEOUT		2
48 #define TA_NETIF_TIMEOUT_MAX		15
49 #define TA_NETIF_TIMEOUT_MIN		2
50 #define TA_GENERATE_NODE_ACLS		0
51 #define TA_DEFAULT_CMDSN_DEPTH		64
52 #define TA_DEFAULT_CMDSN_DEPTH_MAX	512
53 #define TA_DEFAULT_CMDSN_DEPTH_MIN	1
54 #define TA_CACHE_DYNAMIC_ACLS		0
55 /* Enabled by default in demo mode (generic_node_acls=1) */
56 #define TA_DEMO_MODE_WRITE_PROTECT	1
57 /* Disabled by default in production mode w/ explict ACLs */
58 #define TA_PROD_MODE_WRITE_PROTECT	0
59 #define TA_DEMO_MODE_DISCOVERY		1
60 #define TA_DEFAULT_ERL			0
61 #define TA_CACHE_CORE_NPS		0
62 /* T10 protection information disabled by default */
63 #define TA_DEFAULT_T10_PI		0
64 #define TA_DEFAULT_FABRIC_PROT_TYPE	0
65 /* TPG status needs to be enabled to return sendtargets discovery endpoint info */
66 #define TA_DEFAULT_TPG_ENABLED_SENDTARGETS 1
67 
68 #define ISCSI_IOV_DATA_BUFFER		5
69 
70 enum iscsit_transport_type {
71 	ISCSI_TCP				= 0,
72 	ISCSI_SCTP_TCP				= 1,
73 	ISCSI_SCTP_UDP				= 2,
74 	ISCSI_IWARP_TCP				= 3,
75 	ISCSI_IWARP_SCTP			= 4,
76 	ISCSI_INFINIBAND			= 5,
77 };
78 
79 /* RFC-3720 7.1.4  Standard Connection State Diagram for a Target */
80 enum target_conn_state_table {
81 	TARG_CONN_STATE_FREE			= 0x1,
82 	TARG_CONN_STATE_XPT_UP			= 0x3,
83 	TARG_CONN_STATE_IN_LOGIN		= 0x4,
84 	TARG_CONN_STATE_LOGGED_IN		= 0x5,
85 	TARG_CONN_STATE_IN_LOGOUT		= 0x6,
86 	TARG_CONN_STATE_LOGOUT_REQUESTED	= 0x7,
87 	TARG_CONN_STATE_CLEANUP_WAIT		= 0x8,
88 };
89 
90 /* RFC-3720 7.3.2  Session State Diagram for a Target */
91 enum target_sess_state_table {
92 	TARG_SESS_STATE_FREE			= 0x1,
93 	TARG_SESS_STATE_ACTIVE			= 0x2,
94 	TARG_SESS_STATE_LOGGED_IN		= 0x3,
95 	TARG_SESS_STATE_FAILED			= 0x4,
96 	TARG_SESS_STATE_IN_CONTINUE		= 0x5,
97 };
98 
99 /* struct iscsi_data_count->type */
100 enum data_count_type {
101 	ISCSI_RX_DATA	= 1,
102 	ISCSI_TX_DATA	= 2,
103 };
104 
105 /* struct iscsi_datain_req->dr_complete */
106 enum datain_req_comp_table {
107 	DATAIN_COMPLETE_NORMAL			= 1,
108 	DATAIN_COMPLETE_WITHIN_COMMAND_RECOVERY = 2,
109 	DATAIN_COMPLETE_CONNECTION_RECOVERY	= 3,
110 };
111 
112 /* struct iscsi_datain_req->recovery */
113 enum datain_req_rec_table {
114 	DATAIN_WITHIN_COMMAND_RECOVERY		= 1,
115 	DATAIN_CONNECTION_RECOVERY		= 2,
116 };
117 
118 /* struct iscsi_portal_group->state */
119 enum tpg_state_table {
120 	TPG_STATE_FREE				= 0,
121 	TPG_STATE_ACTIVE			= 1,
122 	TPG_STATE_INACTIVE			= 2,
123 	TPG_STATE_COLD_RESET			= 3,
124 };
125 
126 /* struct iscsi_tiqn->tiqn_state */
127 enum tiqn_state_table {
128 	TIQN_STATE_ACTIVE			= 1,
129 	TIQN_STATE_SHUTDOWN			= 2,
130 };
131 
132 /* struct iscsi_cmd->cmd_flags */
133 enum cmd_flags_table {
134 	ICF_GOT_LAST_DATAOUT			= 0x00000001,
135 	ICF_GOT_DATACK_SNACK			= 0x00000002,
136 	ICF_NON_IMMEDIATE_UNSOLICITED_DATA	= 0x00000004,
137 	ICF_SENT_LAST_R2T			= 0x00000008,
138 	ICF_WITHIN_COMMAND_RECOVERY		= 0x00000010,
139 	ICF_CONTIG_MEMORY			= 0x00000020,
140 	ICF_ATTACHED_TO_RQUEUE			= 0x00000040,
141 	ICF_OOO_CMDSN				= 0x00000080,
142 	ICF_SENDTARGETS_ALL			= 0x00000100,
143 	ICF_SENDTARGETS_SINGLE			= 0x00000200,
144 };
145 
146 /* struct iscsi_cmd->i_state */
147 enum cmd_i_state_table {
148 	ISTATE_NO_STATE			= 0,
149 	ISTATE_NEW_CMD			= 1,
150 	ISTATE_DEFERRED_CMD		= 2,
151 	ISTATE_UNSOLICITED_DATA		= 3,
152 	ISTATE_RECEIVE_DATAOUT		= 4,
153 	ISTATE_RECEIVE_DATAOUT_RECOVERY	= 5,
154 	ISTATE_RECEIVED_LAST_DATAOUT	= 6,
155 	ISTATE_WITHIN_DATAOUT_RECOVERY	= 7,
156 	ISTATE_IN_CONNECTION_RECOVERY	= 8,
157 	ISTATE_RECEIVED_TASKMGT		= 9,
158 	ISTATE_SEND_ASYNCMSG		= 10,
159 	ISTATE_SENT_ASYNCMSG		= 11,
160 	ISTATE_SEND_DATAIN		= 12,
161 	ISTATE_SEND_LAST_DATAIN		= 13,
162 	ISTATE_SENT_LAST_DATAIN		= 14,
163 	ISTATE_SEND_LOGOUTRSP		= 15,
164 	ISTATE_SENT_LOGOUTRSP		= 16,
165 	ISTATE_SEND_NOPIN		= 17,
166 	ISTATE_SENT_NOPIN		= 18,
167 	ISTATE_SEND_REJECT		= 19,
168 	ISTATE_SENT_REJECT		= 20,
169 	ISTATE_SEND_R2T			= 21,
170 	ISTATE_SENT_R2T			= 22,
171 	ISTATE_SEND_R2T_RECOVERY	= 23,
172 	ISTATE_SENT_R2T_RECOVERY	= 24,
173 	ISTATE_SEND_LAST_R2T		= 25,
174 	ISTATE_SENT_LAST_R2T		= 26,
175 	ISTATE_SEND_LAST_R2T_RECOVERY	= 27,
176 	ISTATE_SENT_LAST_R2T_RECOVERY	= 28,
177 	ISTATE_SEND_STATUS		= 29,
178 	ISTATE_SEND_STATUS_BROKEN_PC	= 30,
179 	ISTATE_SENT_STATUS		= 31,
180 	ISTATE_SEND_STATUS_RECOVERY	= 32,
181 	ISTATE_SENT_STATUS_RECOVERY	= 33,
182 	ISTATE_SEND_TASKMGTRSP		= 34,
183 	ISTATE_SENT_TASKMGTRSP		= 35,
184 	ISTATE_SEND_TEXTRSP		= 36,
185 	ISTATE_SENT_TEXTRSP		= 37,
186 	ISTATE_SEND_NOPIN_WANT_RESPONSE	= 38,
187 	ISTATE_SENT_NOPIN_WANT_RESPONSE	= 39,
188 	ISTATE_SEND_NOPIN_NO_RESPONSE	= 40,
189 	ISTATE_REMOVE			= 41,
190 	ISTATE_FREE			= 42,
191 };
192 
193 /* Used for iscsi_recover_cmdsn() return values */
194 enum recover_cmdsn_ret_table {
195 	CMDSN_ERROR_CANNOT_RECOVER	= -1,
196 	CMDSN_NORMAL_OPERATION		= 0,
197 	CMDSN_LOWER_THAN_EXP		= 1,
198 	CMDSN_HIGHER_THAN_EXP		= 2,
199 	CMDSN_MAXCMDSN_OVERRUN		= 3,
200 };
201 
202 /* Used for iscsi_handle_immediate_data() return values */
203 enum immedate_data_ret_table {
204 	IMMEDIATE_DATA_CANNOT_RECOVER	= -1,
205 	IMMEDIATE_DATA_NORMAL_OPERATION = 0,
206 	IMMEDIATE_DATA_ERL1_CRC_FAILURE = 1,
207 };
208 
209 /* Used for iscsi_decide_dataout_action() return values */
210 enum dataout_action_ret_table {
211 	DATAOUT_CANNOT_RECOVER		= -1,
212 	DATAOUT_NORMAL			= 0,
213 	DATAOUT_SEND_R2T		= 1,
214 	DATAOUT_SEND_TO_TRANSPORT	= 2,
215 	DATAOUT_WITHIN_COMMAND_RECOVERY = 3,
216 };
217 
218 /* Used for struct iscsi_node_auth->naf_flags */
219 enum naf_flags_table {
220 	NAF_USERID_SET			= 0x01,
221 	NAF_PASSWORD_SET		= 0x02,
222 	NAF_USERID_IN_SET		= 0x04,
223 	NAF_PASSWORD_IN_SET		= 0x08,
224 };
225 
226 /* Used by various struct timer_list to manage iSCSI specific state */
227 enum iscsi_timer_flags_table {
228 	ISCSI_TF_RUNNING		= 0x01,
229 	ISCSI_TF_STOP			= 0x02,
230 	ISCSI_TF_EXPIRED		= 0x04,
231 };
232 
233 /* Used for struct iscsi_np->np_flags */
234 enum np_flags_table {
235 	NPF_IP_NETWORK		= 0x00,
236 };
237 
238 /* Used for struct iscsi_np->np_thread_state */
239 enum np_thread_state_table {
240 	ISCSI_NP_THREAD_ACTIVE		= 1,
241 	ISCSI_NP_THREAD_INACTIVE	= 2,
242 	ISCSI_NP_THREAD_RESET		= 3,
243 	ISCSI_NP_THREAD_SHUTDOWN	= 4,
244 	ISCSI_NP_THREAD_EXIT		= 5,
245 };
246 
247 struct iscsi_conn_ops {
248 	u8	HeaderDigest;			/* [0,1] == [None,CRC32C] */
249 	u8	DataDigest;			/* [0,1] == [None,CRC32C] */
250 	u32	MaxRecvDataSegmentLength;	/* [512..2**24-1] */
251 	u32	MaxXmitDataSegmentLength;	/* [512..2**24-1] */
252 	/*
253 	 * iSER specific connection parameters
254 	 */
255 	u32	InitiatorRecvDataSegmentLength;	/* [512..2**24-1] */
256 	u32	TargetRecvDataSegmentLength;	/* [512..2**24-1] */
257 };
258 
259 struct 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]*/
278 	/*
279 	 * iSER specific session parameters
280 	 */
281 	u8	RDMAExtensions;			/* [0,1] == [No,Yes] */
282 };
283 
284 struct iscsi_queue_req {
285 	int			state;
286 	struct iscsi_cmd	*cmd;
287 	struct list_head	qr_list;
288 };
289 
290 struct 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 
300 struct iscsi_param_list {
301 	bool			iser;
302 	struct list_head	param_list;
303 	struct list_head	extra_response_list;
304 };
305 
306 struct 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;
314 	u32			data_sn;
315 	u32			next_burst_len;
316 	u32			read_data_done;
317 	u32			seq_send_order;
318 	struct list_head	cmd_datain_node;
319 } ____cacheline_aligned;
320 
321 struct 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 
330 struct iscsi_datain {
331 	u8			flags;
332 	u32			data_sn;
333 	u32			length;
334 	u32			offset;
335 } ____cacheline_aligned;
336 
337 struct 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 
348 struct 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;
374 	/* Reject reason code */
375 	u8			reject_reason;
376 	/* 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 */
381 	itt_t			init_task_tag;
382 	/* 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;
400 	/* 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;
415 	/* 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;
437 	/* Used by SendTargets=[iqn.,eui.] discovery */
438 	void			*text_in_ptr;
439 	/* 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;
446 	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;
458 	/* 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 */
482 	struct list_head	i_conn_node;
483 	/* 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 
489 	u32			padding;
490 	u8			pad_bytes[4];
491 
492 	struct scatterlist	*first_data_sg;
493 	u32			first_data_sg_off;
494 	u32			kmapped_nents;
495 	sense_reason_t		sense_reason;
496 }  ____cacheline_aligned;
497 
498 struct iscsi_tmr_req {
499 	bool			task_reassign:1;
500 	u32			exp_data_sn;
501 	struct iscsi_cmd	*ref_cmd;
502 	struct iscsi_conn_recovery *conn_recovery;
503 	struct se_tmr_req	*se_tmr_req;
504 };
505 
506 struct iscsi_conn {
507 	wait_queue_head_t	queues_wq;
508 	/* 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;
516 	/* 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;
522 	int			net_size;
523 	int			login_family;
524 	u32			auth_id;
525 	u32			conn_flags;
526 	/* Used for iscsi_tx_login_rsp() */
527 	itt_t			login_itt;
528 	u32			exp_statsn;
529 	/* Per connection status sequence number */
530 	u32			stat_sn;
531 	struct sockaddr_storage login_sockaddr;
532 	struct sockaddr_storage local_sockaddr;
533 	int			conn_usage_count;
534 	int			conn_waiting_on_uc;
535 	atomic_t		check_immediate_queue;
536 	atomic_t		conn_logout_remove;
537 	atomic_t		connection_exit;
538 	atomic_t		connection_recovery;
539 	atomic_t		connection_reinstatement;
540 	atomic_t		connection_wait_rcfr;
541 	atomic_t		sleep_on_conn_wait_comp;
542 	atomic_t		transport_failed;
543 	struct completion	conn_post_wait_comp;
544 	struct completion	conn_wait_comp;
545 	struct completion	conn_wait_rcfr_comp;
546 	struct completion	conn_waiting_on_uc_comp;
547 	struct completion	conn_logout_comp;
548 	struct completion	tx_half_close_comp;
549 	struct completion	rx_half_close_comp;
550 	/* socket used by this connection */
551 	struct socket		*sock;
552 	void			(*orig_data_ready)(struct sock *);
553 	void			(*orig_state_change)(struct sock *);
554 #define LOGIN_FLAGS_READ_ACTIVE		1
555 #define LOGIN_FLAGS_CLOSED		2
556 #define LOGIN_FLAGS_READY		4
557 	unsigned long		login_flags;
558 	struct delayed_work	login_work;
559 	struct delayed_work	login_cleanup_work;
560 	struct iscsi_login	*login;
561 	struct timer_list	nopin_timer;
562 	struct timer_list	nopin_response_timer;
563 	struct timer_list	transport_timer;
564 	struct task_struct	*login_kworker;
565 	/* Spinlock used for add/deleting cmd's from conn_cmd_list */
566 	spinlock_t		cmd_lock;
567 	spinlock_t		conn_usage_lock;
568 	spinlock_t		immed_queue_lock;
569 	spinlock_t		nopin_timer_lock;
570 	spinlock_t		response_queue_lock;
571 	spinlock_t		state_lock;
572 	/* libcrypto RX and TX contexts for crc32c */
573 	struct hash_desc	conn_rx_hash;
574 	struct hash_desc	conn_tx_hash;
575 	/* Used for scheduling TX and RX connection kthreads */
576 	cpumask_var_t		conn_cpumask;
577 	unsigned int		conn_rx_reset_cpumask:1;
578 	unsigned int		conn_tx_reset_cpumask:1;
579 	/* list_head of struct iscsi_cmd for this connection */
580 	struct list_head	conn_cmd_list;
581 	struct list_head	immed_queue_list;
582 	struct list_head	response_queue_list;
583 	struct iscsi_conn_ops	*conn_ops;
584 	struct iscsi_login	*conn_login;
585 	struct iscsit_transport *conn_transport;
586 	struct iscsi_param_list	*param_list;
587 	/* Used for per connection auth state machine */
588 	void			*auth_protocol;
589 	void			*context;
590 	struct iscsi_login_thread_s *login_thread;
591 	struct iscsi_portal_group *tpg;
592 	struct iscsi_tpg_np	*tpg_np;
593 	/* Pointer to parent session */
594 	struct iscsi_session	*sess;
595 	int			bitmap_id;
596 	int			rx_thread_active;
597 	struct task_struct	*rx_thread;
598 	struct completion	rx_login_comp;
599 	int			tx_thread_active;
600 	struct task_struct	*tx_thread;
601 	/* list_head for session connection list */
602 	struct list_head	conn_list;
603 } ____cacheline_aligned;
604 
605 struct iscsi_conn_recovery {
606 	u16			cid;
607 	u32			cmd_count;
608 	u32			maxrecvdatasegmentlength;
609 	u32			maxxmitdatasegmentlength;
610 	int			ready_for_reallegiance;
611 	struct list_head	conn_recovery_cmd_list;
612 	spinlock_t		conn_recovery_cmd_lock;
613 	struct timer_list	time2retain_timer;
614 	struct iscsi_session	*sess;
615 	struct list_head	cr_list;
616 }  ____cacheline_aligned;
617 
618 struct iscsi_session {
619 	u8			initiator_vendor;
620 	u8			isid[6];
621 	enum iscsi_timer_flags_table time2retain_timer_flags;
622 	u8			version_active;
623 	u16			cid_called;
624 	u16			conn_recovery_count;
625 	u16			tsih;
626 	/* state session is currently in */
627 	u32			session_state;
628 	/* session wide counter: initiator assigned task tag */
629 	itt_t			init_task_tag;
630 	/* session wide counter: target assigned task tag */
631 	u32			targ_xfer_tag;
632 	u32			cmdsn_window;
633 
634 	/* protects cmdsn values */
635 	struct mutex		cmdsn_mutex;
636 	/* session wide counter: expected command sequence number */
637 	u32			exp_cmd_sn;
638 	/* session wide counter: maximum allowed command sequence number */
639 	atomic_t		max_cmd_sn;
640 	struct list_head	sess_ooo_cmdsn_list;
641 
642 	/* LIO specific session ID */
643 	u32			sid;
644 	char			auth_type[8];
645 	/* unique within the target */
646 	int			session_index;
647 	/* Used for session reference counting */
648 	int			session_usage_count;
649 	int			session_waiting_on_uc;
650 	atomic_long_t		cmd_pdus;
651 	atomic_long_t		rsp_pdus;
652 	atomic_long_t		tx_data_octets;
653 	atomic_long_t		rx_data_octets;
654 	atomic_long_t		conn_digest_errors;
655 	atomic_long_t		conn_timeout_errors;
656 	u64			creation_time;
657 	/* Number of active connections */
658 	atomic_t		nconn;
659 	atomic_t		session_continuation;
660 	atomic_t		session_fall_back_to_erl0;
661 	atomic_t		session_logout;
662 	atomic_t		session_reinstatement;
663 	atomic_t		session_stop_active;
664 	atomic_t		sleep_on_sess_wait_comp;
665 	/* connection list */
666 	struct list_head	sess_conn_list;
667 	struct list_head	cr_active_list;
668 	struct list_head	cr_inactive_list;
669 	spinlock_t		conn_lock;
670 	spinlock_t		cr_a_lock;
671 	spinlock_t		cr_i_lock;
672 	spinlock_t		session_usage_lock;
673 	spinlock_t		ttt_lock;
674 	struct completion	async_msg_comp;
675 	struct completion	reinstatement_comp;
676 	struct completion	session_wait_comp;
677 	struct completion	session_waiting_on_uc_comp;
678 	struct timer_list	time2retain_timer;
679 	struct iscsi_sess_ops	*sess_ops;
680 	struct se_session	*se_sess;
681 	struct iscsi_portal_group *tpg;
682 } ____cacheline_aligned;
683 
684 struct iscsi_login {
685 	u8 auth_complete;
686 	u8 checked_for_existing;
687 	u8 current_stage;
688 	u8 leading_connection;
689 	u8 first_request;
690 	u8 version_min;
691 	u8 version_max;
692 	u8 login_complete;
693 	u8 login_failed;
694 	bool zero_tsih;
695 	char isid[6];
696 	u32 cmd_sn;
697 	itt_t init_task_tag;
698 	u32 initial_exp_statsn;
699 	u32 rsp_length;
700 	u16 cid;
701 	u16 tsih;
702 	char req[ISCSI_HDR_LEN];
703 	char rsp[ISCSI_HDR_LEN];
704 	char *req_buf;
705 	char *rsp_buf;
706 	struct iscsi_conn *conn;
707 	struct iscsi_np *np;
708 } ____cacheline_aligned;
709 
710 struct iscsi_node_attrib {
711 	u32			dataout_timeout;
712 	u32			dataout_timeout_retries;
713 	u32			default_erl;
714 	u32			nopin_timeout;
715 	u32			nopin_response_timeout;
716 	u32			random_datain_pdu_offsets;
717 	u32			random_datain_seq_offsets;
718 	u32			random_r2t_offsets;
719 	u32			tmr_cold_reset;
720 	u32			tmr_warm_reset;
721 	struct iscsi_node_acl *nacl;
722 };
723 
724 struct se_dev_entry_s;
725 
726 struct iscsi_node_auth {
727 	enum naf_flags_table	naf_flags;
728 	int			authenticate_target;
729 	/* Used for iscsit_global->discovery_auth,
730 	 * set to zero (auth disabled) by default */
731 	int			enforce_discovery_auth;
732 #define MAX_USER_LEN				256
733 #define MAX_PASS_LEN				256
734 	char			userid[MAX_USER_LEN];
735 	char			password[MAX_PASS_LEN];
736 	char			userid_mutual[MAX_USER_LEN];
737 	char			password_mutual[MAX_PASS_LEN];
738 };
739 
740 #include "iscsi_target_stat.h"
741 
742 struct iscsi_node_stat_grps {
743 	struct config_group	iscsi_sess_stats_group;
744 	struct config_group	iscsi_conn_stats_group;
745 };
746 
747 struct iscsi_node_acl {
748 	struct se_node_acl	se_node_acl;
749 	struct iscsi_node_attrib node_attrib;
750 	struct iscsi_node_auth	node_auth;
751 	struct iscsi_node_stat_grps node_stat_grps;
752 };
753 
754 struct iscsi_tpg_attrib {
755 	u32			authentication;
756 	u32			login_timeout;
757 	u32			netif_timeout;
758 	u32			generate_node_acls;
759 	u32			cache_dynamic_acls;
760 	u32			default_cmdsn_depth;
761 	u32			demo_mode_write_protect;
762 	u32			prod_mode_write_protect;
763 	u32			demo_mode_discovery;
764 	u32			default_erl;
765 	u8			t10_pi;
766 	u32			fabric_prot_type;
767 	u32			tpg_enabled_sendtargets;
768 	struct iscsi_portal_group *tpg;
769 };
770 
771 struct iscsi_np {
772 	int			np_network_transport;
773 	int			np_ip_proto;
774 	int			np_sock_type;
775 	enum np_thread_state_table np_thread_state;
776 	bool                    enabled;
777 	enum iscsi_timer_flags_table np_login_timer_flags;
778 	u32			np_exports;
779 	enum np_flags_table	np_flags;
780 	spinlock_t		np_thread_lock;
781 	struct completion	np_restart_comp;
782 	struct socket		*np_socket;
783 	struct sockaddr_storage np_sockaddr;
784 	struct task_struct	*np_thread;
785 	struct timer_list	np_login_timer;
786 	void			*np_context;
787 	struct iscsit_transport *np_transport;
788 	struct list_head	np_list;
789 } ____cacheline_aligned;
790 
791 struct iscsi_tpg_np {
792 	struct iscsi_np		*tpg_np;
793 	struct iscsi_portal_group *tpg;
794 	struct iscsi_tpg_np	*tpg_np_parent;
795 	struct list_head	tpg_np_list;
796 	struct list_head	tpg_np_child_list;
797 	struct list_head	tpg_np_parent_list;
798 	struct se_tpg_np	se_tpg_np;
799 	spinlock_t		tpg_np_parent_lock;
800 	struct completion	tpg_np_comp;
801 	struct kref		tpg_np_kref;
802 };
803 
804 struct iscsi_portal_group {
805 	unsigned char		tpg_chap_id;
806 	/* TPG State */
807 	enum tpg_state_table	tpg_state;
808 	/* Target Portal Group Tag */
809 	u16			tpgt;
810 	/* Id assigned to target sessions */
811 	u16			ntsih;
812 	/* Number of active sessions */
813 	u32			nsessions;
814 	/* Number of Network Portals available for this TPG */
815 	u32			num_tpg_nps;
816 	/* Per TPG LIO specific session ID. */
817 	u32			sid;
818 	/* Spinlock for adding/removing Network Portals */
819 	spinlock_t		tpg_np_lock;
820 	spinlock_t		tpg_state_lock;
821 	struct se_portal_group tpg_se_tpg;
822 	struct mutex		tpg_access_lock;
823 	struct semaphore	np_login_sem;
824 	struct iscsi_tpg_attrib	tpg_attrib;
825 	struct iscsi_node_auth	tpg_demo_auth;
826 	/* Pointer to default list of iSCSI parameters for TPG */
827 	struct iscsi_param_list	*param_list;
828 	struct iscsi_tiqn	*tpg_tiqn;
829 	struct list_head	tpg_gnp_list;
830 	struct list_head	tpg_list;
831 } ____cacheline_aligned;
832 
833 struct iscsi_wwn_stat_grps {
834 	struct config_group	iscsi_stat_group;
835 	struct config_group	iscsi_instance_group;
836 	struct config_group	iscsi_sess_err_group;
837 	struct config_group	iscsi_tgt_attr_group;
838 	struct config_group	iscsi_login_stats_group;
839 	struct config_group	iscsi_logout_stats_group;
840 };
841 
842 struct iscsi_tiqn {
843 #define ISCSI_IQN_LEN				224
844 	unsigned char		tiqn[ISCSI_IQN_LEN];
845 	enum tiqn_state_table	tiqn_state;
846 	int			tiqn_access_count;
847 	u32			tiqn_active_tpgs;
848 	u32			tiqn_ntpgs;
849 	u32			tiqn_num_tpg_nps;
850 	u32			tiqn_nsessions;
851 	struct list_head	tiqn_list;
852 	struct list_head	tiqn_tpg_list;
853 	spinlock_t		tiqn_state_lock;
854 	spinlock_t		tiqn_tpg_lock;
855 	struct se_wwn		tiqn_wwn;
856 	struct iscsi_wwn_stat_grps tiqn_stat_grps;
857 	int			tiqn_index;
858 	struct iscsi_sess_err_stats  sess_err_stats;
859 	struct iscsi_login_stats     login_stats;
860 	struct iscsi_logout_stats    logout_stats;
861 } ____cacheline_aligned;
862 
863 struct iscsit_global {
864 	/* In core shutdown */
865 	u32			in_shutdown;
866 	u32			active_ts;
867 	/* Unique identifier used for the authentication daemon */
868 	u32			auth_id;
869 	u32			inactive_ts;
870 #define ISCSIT_BITMAP_BITS	262144
871 	/* Thread Set bitmap pointer */
872 	unsigned long		*ts_bitmap;
873 	spinlock_t		ts_bitmap_lock;
874 	/* Used for iSCSI discovery session authentication */
875 	struct iscsi_node_acl	discovery_acl;
876 	struct iscsi_portal_group	*discovery_tpg;
877 };
878 
879 static inline u32 session_get_next_ttt(struct iscsi_session *session)
880 {
881 	u32 ttt;
882 
883 	spin_lock_bh(&session->ttt_lock);
884 	ttt = session->targ_xfer_tag++;
885 	if (ttt == 0xFFFFFFFF)
886 		ttt = session->targ_xfer_tag++;
887 	spin_unlock_bh(&session->ttt_lock);
888 
889 	return ttt;
890 }
891 
892 extern struct iscsi_cmd *iscsit_find_cmd_from_itt(struct iscsi_conn *, itt_t);
893 #endif /* ISCSI_TARGET_CORE_H */
894