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