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