Loading...
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-rc1"
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 5
29#define NA_NOPIN_TIMEOUT_MAX 60
30#define NA_NOPIN_TIMEOUT_MIN 3
31#define NA_NOPIN_RESPONSE_TIMEOUT 5
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
60enum tpg_np_network_transport_table {
61 ISCSI_TCP = 0,
62 ISCSI_SCTP_TCP = 1,
63 ISCSI_SCTP_UDP = 2,
64 ISCSI_IWARP_TCP = 3,
65 ISCSI_IWARP_SCTP = 4,
66 ISCSI_INFINIBAND = 5,
67};
68
69/* RFC-3720 7.1.4 Standard Connection State Diagram for a Target */
70enum target_conn_state_table {
71 TARG_CONN_STATE_FREE = 0x1,
72 TARG_CONN_STATE_XPT_UP = 0x3,
73 TARG_CONN_STATE_IN_LOGIN = 0x4,
74 TARG_CONN_STATE_LOGGED_IN = 0x5,
75 TARG_CONN_STATE_IN_LOGOUT = 0x6,
76 TARG_CONN_STATE_LOGOUT_REQUESTED = 0x7,
77 TARG_CONN_STATE_CLEANUP_WAIT = 0x8,
78};
79
80/* RFC-3720 7.3.2 Session State Diagram for a Target */
81enum target_sess_state_table {
82 TARG_SESS_STATE_FREE = 0x1,
83 TARG_SESS_STATE_ACTIVE = 0x2,
84 TARG_SESS_STATE_LOGGED_IN = 0x3,
85 TARG_SESS_STATE_FAILED = 0x4,
86 TARG_SESS_STATE_IN_CONTINUE = 0x5,
87};
88
89/* struct iscsi_data_count->type */
90enum data_count_type {
91 ISCSI_RX_DATA = 1,
92 ISCSI_TX_DATA = 2,
93};
94
95/* struct iscsi_datain_req->dr_complete */
96enum datain_req_comp_table {
97 DATAIN_COMPLETE_NORMAL = 1,
98 DATAIN_COMPLETE_WITHIN_COMMAND_RECOVERY = 2,
99 DATAIN_COMPLETE_CONNECTION_RECOVERY = 3,
100};
101
102/* struct iscsi_datain_req->recovery */
103enum datain_req_rec_table {
104 DATAIN_WITHIN_COMMAND_RECOVERY = 1,
105 DATAIN_CONNECTION_RECOVERY = 2,
106};
107
108/* struct iscsi_portal_group->state */
109enum tpg_state_table {
110 TPG_STATE_FREE = 0,
111 TPG_STATE_ACTIVE = 1,
112 TPG_STATE_INACTIVE = 2,
113 TPG_STATE_COLD_RESET = 3,
114};
115
116/* struct iscsi_tiqn->tiqn_state */
117enum tiqn_state_table {
118 TIQN_STATE_ACTIVE = 1,
119 TIQN_STATE_SHUTDOWN = 2,
120};
121
122/* struct iscsi_cmd->cmd_flags */
123enum cmd_flags_table {
124 ICF_GOT_LAST_DATAOUT = 0x00000001,
125 ICF_GOT_DATACK_SNACK = 0x00000002,
126 ICF_NON_IMMEDIATE_UNSOLICITED_DATA = 0x00000004,
127 ICF_SENT_LAST_R2T = 0x00000008,
128 ICF_WITHIN_COMMAND_RECOVERY = 0x00000010,
129 ICF_CONTIG_MEMORY = 0x00000020,
130 ICF_ATTACHED_TO_RQUEUE = 0x00000040,
131 ICF_OOO_CMDSN = 0x00000080,
132 ICF_REJECT_FAIL_CONN = 0x00000100,
133};
134
135/* struct iscsi_cmd->i_state */
136enum cmd_i_state_table {
137 ISTATE_NO_STATE = 0,
138 ISTATE_NEW_CMD = 1,
139 ISTATE_DEFERRED_CMD = 2,
140 ISTATE_UNSOLICITED_DATA = 3,
141 ISTATE_RECEIVE_DATAOUT = 4,
142 ISTATE_RECEIVE_DATAOUT_RECOVERY = 5,
143 ISTATE_RECEIVED_LAST_DATAOUT = 6,
144 ISTATE_WITHIN_DATAOUT_RECOVERY = 7,
145 ISTATE_IN_CONNECTION_RECOVERY = 8,
146 ISTATE_RECEIVED_TASKMGT = 9,
147 ISTATE_SEND_ASYNCMSG = 10,
148 ISTATE_SENT_ASYNCMSG = 11,
149 ISTATE_SEND_DATAIN = 12,
150 ISTATE_SEND_LAST_DATAIN = 13,
151 ISTATE_SENT_LAST_DATAIN = 14,
152 ISTATE_SEND_LOGOUTRSP = 15,
153 ISTATE_SENT_LOGOUTRSP = 16,
154 ISTATE_SEND_NOPIN = 17,
155 ISTATE_SENT_NOPIN = 18,
156 ISTATE_SEND_REJECT = 19,
157 ISTATE_SENT_REJECT = 20,
158 ISTATE_SEND_R2T = 21,
159 ISTATE_SENT_R2T = 22,
160 ISTATE_SEND_R2T_RECOVERY = 23,
161 ISTATE_SENT_R2T_RECOVERY = 24,
162 ISTATE_SEND_LAST_R2T = 25,
163 ISTATE_SENT_LAST_R2T = 26,
164 ISTATE_SEND_LAST_R2T_RECOVERY = 27,
165 ISTATE_SENT_LAST_R2T_RECOVERY = 28,
166 ISTATE_SEND_STATUS = 29,
167 ISTATE_SEND_STATUS_BROKEN_PC = 30,
168 ISTATE_SENT_STATUS = 31,
169 ISTATE_SEND_STATUS_RECOVERY = 32,
170 ISTATE_SENT_STATUS_RECOVERY = 33,
171 ISTATE_SEND_TASKMGTRSP = 34,
172 ISTATE_SENT_TASKMGTRSP = 35,
173 ISTATE_SEND_TEXTRSP = 36,
174 ISTATE_SENT_TEXTRSP = 37,
175 ISTATE_SEND_NOPIN_WANT_RESPONSE = 38,
176 ISTATE_SENT_NOPIN_WANT_RESPONSE = 39,
177 ISTATE_SEND_NOPIN_NO_RESPONSE = 40,
178 ISTATE_REMOVE = 41,
179 ISTATE_FREE = 42,
180};
181
182/* Used for iscsi_recover_cmdsn() return values */
183enum recover_cmdsn_ret_table {
184 CMDSN_ERROR_CANNOT_RECOVER = -1,
185 CMDSN_NORMAL_OPERATION = 0,
186 CMDSN_LOWER_THAN_EXP = 1,
187 CMDSN_HIGHER_THAN_EXP = 2,
188};
189
190/* Used for iscsi_handle_immediate_data() return values */
191enum immedate_data_ret_table {
192 IMMEDIATE_DATA_CANNOT_RECOVER = -1,
193 IMMEDIATE_DATA_NORMAL_OPERATION = 0,
194 IMMEDIATE_DATA_ERL1_CRC_FAILURE = 1,
195};
196
197/* Used for iscsi_decide_dataout_action() return values */
198enum dataout_action_ret_table {
199 DATAOUT_CANNOT_RECOVER = -1,
200 DATAOUT_NORMAL = 0,
201 DATAOUT_SEND_R2T = 1,
202 DATAOUT_SEND_TO_TRANSPORT = 2,
203 DATAOUT_WITHIN_COMMAND_RECOVERY = 3,
204};
205
206/* Used for struct iscsi_node_auth->naf_flags */
207enum naf_flags_table {
208 NAF_USERID_SET = 0x01,
209 NAF_PASSWORD_SET = 0x02,
210 NAF_USERID_IN_SET = 0x04,
211 NAF_PASSWORD_IN_SET = 0x08,
212};
213
214/* Used by various struct timer_list to manage iSCSI specific state */
215enum iscsi_timer_flags_table {
216 ISCSI_TF_RUNNING = 0x01,
217 ISCSI_TF_STOP = 0x02,
218 ISCSI_TF_EXPIRED = 0x04,
219};
220
221/* Used for struct iscsi_np->np_flags */
222enum np_flags_table {
223 NPF_IP_NETWORK = 0x00,
224 NPF_SCTP_STRUCT_FILE = 0x01 /* Bugfix */
225};
226
227/* Used for struct iscsi_np->np_thread_state */
228enum np_thread_state_table {
229 ISCSI_NP_THREAD_ACTIVE = 1,
230 ISCSI_NP_THREAD_INACTIVE = 2,
231 ISCSI_NP_THREAD_RESET = 3,
232 ISCSI_NP_THREAD_SHUTDOWN = 4,
233 ISCSI_NP_THREAD_EXIT = 5,
234};
235
236struct iscsi_conn_ops {
237 u8 HeaderDigest; /* [0,1] == [None,CRC32C] */
238 u8 DataDigest; /* [0,1] == [None,CRC32C] */
239 u32 MaxRecvDataSegmentLength; /* [512..2**24-1] */
240 u8 OFMarker; /* [0,1] == [No,Yes] */
241 u8 IFMarker; /* [0,1] == [No,Yes] */
242 u32 OFMarkInt; /* [1..65535] */
243 u32 IFMarkInt; /* [1..65535] */
244};
245
246struct iscsi_sess_ops {
247 char InitiatorName[224];
248 char InitiatorAlias[256];
249 char TargetName[224];
250 char TargetAlias[256];
251 char TargetAddress[256];
252 u16 TargetPortalGroupTag; /* [0..65535] */
253 u16 MaxConnections; /* [1..65535] */
254 u8 InitialR2T; /* [0,1] == [No,Yes] */
255 u8 ImmediateData; /* [0,1] == [No,Yes] */
256 u32 MaxBurstLength; /* [512..2**24-1] */
257 u32 FirstBurstLength; /* [512..2**24-1] */
258 u16 DefaultTime2Wait; /* [0..3600] */
259 u16 DefaultTime2Retain; /* [0..3600] */
260 u16 MaxOutstandingR2T; /* [1..65535] */
261 u8 DataPDUInOrder; /* [0,1] == [No,Yes] */
262 u8 DataSequenceInOrder; /* [0,1] == [No,Yes] */
263 u8 ErrorRecoveryLevel; /* [0..2] */
264 u8 SessionType; /* [0,1] == [Normal,Discovery]*/
265};
266
267struct iscsi_queue_req {
268 int state;
269 struct iscsi_cmd *cmd;
270 struct list_head qr_list;
271};
272
273struct iscsi_data_count {
274 int data_length;
275 int sync_and_steering;
276 enum data_count_type type;
277 u32 iov_count;
278 u32 ss_iov_count;
279 u32 ss_marker_count;
280 struct kvec *iov;
281};
282
283struct iscsi_param_list {
284 struct list_head param_list;
285 struct list_head extra_response_list;
286};
287
288struct iscsi_datain_req {
289 enum datain_req_comp_table dr_complete;
290 int generate_recovery_values;
291 enum datain_req_rec_table recovery;
292 u32 begrun;
293 u32 runlength;
294 u32 data_length;
295 u32 data_offset;
296 u32 data_offset_end;
297 u32 data_sn;
298 u32 next_burst_len;
299 u32 read_data_done;
300 u32 seq_send_order;
301 struct list_head dr_list;
302} ____cacheline_aligned;
303
304struct iscsi_ooo_cmdsn {
305 u16 cid;
306 u32 batch_count;
307 u32 cmdsn;
308 u32 exp_cmdsn;
309 struct iscsi_cmd *cmd;
310 struct list_head ooo_list;
311} ____cacheline_aligned;
312
313struct iscsi_datain {
314 u8 flags;
315 u32 data_sn;
316 u32 length;
317 u32 offset;
318} ____cacheline_aligned;
319
320struct iscsi_r2t {
321 int seq_complete;
322 int recovery_r2t;
323 int sent_r2t;
324 u32 r2t_sn;
325 u32 offset;
326 u32 targ_xfer_tag;
327 u32 xfer_len;
328 struct list_head r2t_list;
329} ____cacheline_aligned;
330
331struct iscsi_cmd {
332 enum iscsi_timer_flags_table dataout_timer_flags;
333 /* DataOUT timeout retries */
334 u8 dataout_timeout_retries;
335 /* Within command recovery count */
336 u8 error_recovery_count;
337 /* iSCSI dependent state for out or order CmdSNs */
338 enum cmd_i_state_table deferred_i_state;
339 /* iSCSI dependent state */
340 enum cmd_i_state_table i_state;
341 /* Command is an immediate command (ISCSI_OP_IMMEDIATE set) */
342 u8 immediate_cmd;
343 /* Immediate data present */
344 u8 immediate_data;
345 /* iSCSI Opcode */
346 u8 iscsi_opcode;
347 /* iSCSI Response Code */
348 u8 iscsi_response;
349 /* Logout reason when iscsi_opcode == ISCSI_INIT_LOGOUT_CMND */
350 u8 logout_reason;
351 /* Logout response code when iscsi_opcode == ISCSI_INIT_LOGOUT_CMND */
352 u8 logout_response;
353 /* MaxCmdSN has been incremented */
354 u8 maxcmdsn_inc;
355 /* Immediate Unsolicited Dataout */
356 u8 unsolicited_data;
357 /* CID contained in logout PDU when opcode == ISCSI_INIT_LOGOUT_CMND */
358 u16 logout_cid;
359 /* Command flags */
360 enum cmd_flags_table cmd_flags;
361 /* Initiator Task Tag assigned from Initiator */
362 u32 init_task_tag;
363 /* Target Transfer Tag assigned from Target */
364 u32 targ_xfer_tag;
365 /* CmdSN assigned from Initiator */
366 u32 cmd_sn;
367 /* ExpStatSN assigned from Initiator */
368 u32 exp_stat_sn;
369 /* StatSN assigned to this ITT */
370 u32 stat_sn;
371 /* DataSN Counter */
372 u32 data_sn;
373 /* R2TSN Counter */
374 u32 r2t_sn;
375 /* Last DataSN acknowledged via DataAck SNACK */
376 u32 acked_data_sn;
377 /* Used for echoing NOPOUT ping data */
378 u32 buf_ptr_size;
379 /* Used to store DataDigest */
380 u32 data_crc;
381 /* Total size in bytes associated with command */
382 u32 data_length;
383 /* Counter for MaxOutstandingR2T */
384 u32 outstanding_r2ts;
385 /* Next R2T Offset when DataSequenceInOrder=Yes */
386 u32 r2t_offset;
387 /* Iovec current and orig count for iscsi_cmd->iov_data */
388 u32 iov_data_count;
389 u32 orig_iov_data_count;
390 /* Number of miscellaneous iovecs used for IP stack calls */
391 u32 iov_misc_count;
392 /* Number of struct iscsi_pdu in struct iscsi_cmd->pdu_list */
393 u32 pdu_count;
394 /* Next struct iscsi_pdu to send in struct iscsi_cmd->pdu_list */
395 u32 pdu_send_order;
396 /* Current struct iscsi_pdu in struct iscsi_cmd->pdu_list */
397 u32 pdu_start;
398 u32 residual_count;
399 /* Next struct iscsi_seq to send in struct iscsi_cmd->seq_list */
400 u32 seq_send_order;
401 /* Number of struct iscsi_seq in struct iscsi_cmd->seq_list */
402 u32 seq_count;
403 /* Current struct iscsi_seq in struct iscsi_cmd->seq_list */
404 u32 seq_no;
405 /* Lowest offset in current DataOUT sequence */
406 u32 seq_start_offset;
407 /* Highest offset in current DataOUT sequence */
408 u32 seq_end_offset;
409 /* Total size in bytes received so far of READ data */
410 u32 read_data_done;
411 /* Total size in bytes received so far of WRITE data */
412 u32 write_data_done;
413 /* Counter for FirstBurstLength key */
414 u32 first_burst_len;
415 /* Counter for MaxBurstLength key */
416 u32 next_burst_len;
417 /* Transfer size used for IP stack calls */
418 u32 tx_size;
419 /* Buffer used for various purposes */
420 void *buf_ptr;
421 /* See include/linux/dma-mapping.h */
422 enum dma_data_direction data_direction;
423 /* iSCSI PDU Header + CRC */
424 unsigned char pdu[ISCSI_HDR_LEN + ISCSI_CRC_LEN];
425 /* Number of times struct iscsi_cmd is present in immediate queue */
426 atomic_t immed_queue_count;
427 atomic_t response_queue_count;
428 atomic_t transport_sent;
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
485struct 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
493struct iscsi_conn {
494 /* Authentication Successful for this connection */
495 u8 auth_complete;
496 /* State connection is currently in */
497 u8 conn_state;
498 u8 conn_logout_reason;
499 u8 network_transport;
500 enum iscsi_timer_flags_table nopin_timer_flags;
501 enum iscsi_timer_flags_table nopin_response_timer_flags;
502 u8 tx_immediate_queue;
503 u8 tx_response_queue;
504 /* Used to know what thread encountered a transport failure */
505 u8 which_thread;
506 /* connection id assigned by the Initiator */
507 u16 cid;
508 /* Remote TCP Port */
509 u16 login_port;
510 int net_size;
511 u32 auth_id;
512#define CONNFLAG_SCTP_STRUCT_FILE 0x01
513 u32 conn_flags;
514 /* Used for iscsi_tx_login_rsp() */
515 u32 login_itt;
516 u32 exp_statsn;
517 /* Per connection status sequence number */
518 u32 stat_sn;
519 /* IFMarkInt's Current Value */
520 u32 if_marker;
521 /* OFMarkInt's Current Value */
522 u32 of_marker;
523 /* Used for calculating OFMarker offset to next PDU */
524 u32 of_marker_offset;
525 /* Complete Bad PDU for sending reject */
526 unsigned char bad_hdr[ISCSI_HDR_LEN];
527#define IPV6_ADDRESS_SPACE 48
528 unsigned char login_ip[IPV6_ADDRESS_SPACE];
529 int conn_usage_count;
530 int conn_waiting_on_uc;
531 atomic_t check_immediate_queue;
532 atomic_t conn_logout_remove;
533 atomic_t connection_exit;
534 atomic_t connection_recovery;
535 atomic_t connection_reinstatement;
536 atomic_t connection_wait;
537 atomic_t connection_wait_rcfr;
538 atomic_t sleep_on_conn_wait_comp;
539 atomic_t transport_failed;
540 struct completion conn_post_wait_comp;
541 struct completion conn_wait_comp;
542 struct completion conn_wait_rcfr_comp;
543 struct completion conn_waiting_on_uc_comp;
544 struct completion conn_logout_comp;
545 struct completion tx_half_close_comp;
546 struct completion rx_half_close_comp;
547 /* socket used by this connection */
548 struct socket *sock;
549 struct timer_list nopin_timer;
550 struct timer_list nopin_response_timer;
551 struct timer_list transport_timer;
552 /* Spinlock used for add/deleting cmd's from conn_cmd_list */
553 spinlock_t cmd_lock;
554 spinlock_t conn_usage_lock;
555 spinlock_t immed_queue_lock;
556 spinlock_t nopin_timer_lock;
557 spinlock_t response_queue_lock;
558 spinlock_t state_lock;
559 /* libcrypto RX and TX contexts for crc32c */
560 struct hash_desc conn_rx_hash;
561 struct hash_desc conn_tx_hash;
562 /* Used for scheduling TX and RX connection kthreads */
563 cpumask_var_t conn_cpumask;
564 int conn_rx_reset_cpumask:1;
565 int conn_tx_reset_cpumask:1;
566 /* list_head of struct iscsi_cmd for this connection */
567 struct list_head conn_cmd_list;
568 struct list_head immed_queue_list;
569 struct list_head response_queue_list;
570 struct iscsi_conn_ops *conn_ops;
571 struct iscsi_param_list *param_list;
572 /* Used for per connection auth state machine */
573 void *auth_protocol;
574 struct iscsi_login_thread_s *login_thread;
575 struct iscsi_portal_group *tpg;
576 /* Pointer to parent session */
577 struct iscsi_session *sess;
578 /* Pointer to thread_set in use for this conn's threads */
579 struct iscsi_thread_set *thread_set;
580 /* list_head for session connection list */
581 struct list_head conn_list;
582} ____cacheline_aligned;
583
584struct iscsi_conn_recovery {
585 u16 cid;
586 u32 cmd_count;
587 u32 maxrecvdatasegmentlength;
588 int ready_for_reallegiance;
589 struct list_head conn_recovery_cmd_list;
590 spinlock_t conn_recovery_cmd_lock;
591 struct timer_list time2retain_timer;
592 struct iscsi_session *sess;
593 struct list_head cr_list;
594} ____cacheline_aligned;
595
596struct iscsi_session {
597 u8 initiator_vendor;
598 u8 isid[6];
599 enum iscsi_timer_flags_table time2retain_timer_flags;
600 u8 version_active;
601 u16 cid_called;
602 u16 conn_recovery_count;
603 u16 tsih;
604 /* state session is currently in */
605 u32 session_state;
606 /* session wide counter: initiator assigned task tag */
607 u32 init_task_tag;
608 /* session wide counter: target assigned task tag */
609 u32 targ_xfer_tag;
610 u32 cmdsn_window;
611
612 /* protects cmdsn values */
613 struct mutex cmdsn_mutex;
614 /* session wide counter: expected command sequence number */
615 u32 exp_cmd_sn;
616 /* session wide counter: maximum allowed command sequence number */
617 u32 max_cmd_sn;
618 struct list_head sess_ooo_cmdsn_list;
619
620 /* LIO specific session ID */
621 u32 sid;
622 char auth_type[8];
623 /* unique within the target */
624 int session_index;
625 /* Used for session reference counting */
626 int session_usage_count;
627 int session_waiting_on_uc;
628 u32 cmd_pdus;
629 u32 rsp_pdus;
630 u64 tx_data_octets;
631 u64 rx_data_octets;
632 u32 conn_digest_errors;
633 u32 conn_timeout_errors;
634 u64 creation_time;
635 spinlock_t session_stats_lock;
636 /* Number of active connections */
637 atomic_t nconn;
638 atomic_t session_continuation;
639 atomic_t session_fall_back_to_erl0;
640 atomic_t session_logout;
641 atomic_t session_reinstatement;
642 atomic_t session_stop_active;
643 atomic_t sleep_on_sess_wait_comp;
644 atomic_t transport_wait_cmds;
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
664struct 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
685struct 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
699struct se_dev_entry_s;
700
701struct 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
717struct iscsi_node_stat_grps {
718 struct config_group iscsi_sess_stats_group;
719 struct config_group iscsi_conn_stats_group;
720};
721
722struct 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
734struct 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
746struct 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
766struct 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
777struct 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
811struct 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
820struct 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
843struct 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 */
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"
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#define ISCSIT_MIN_TAGS 16
21#define ISCSIT_EXTRA_TAGS 8
22#define ISCSIT_TCP_BACKLOG 256
23
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
31#define NA_NOPIN_TIMEOUT 15
32#define NA_NOPIN_TIMEOUT_MAX 60
33#define NA_NOPIN_TIMEOUT_MIN 3
34#define NA_NOPIN_RESPONSE_TIMEOUT 30
35#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
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 64
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_DEMO_MODE_DISCOVERY 1
59#define TA_DEFAULT_ERL 0
60#define TA_CACHE_CORE_NPS 0
61/* T10 protection information disabled by default */
62#define TA_DEFAULT_T10_PI 0
63
64#define ISCSI_IOV_DATA_BUFFER 5
65
66enum iscsit_transport_type {
67 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,
138 IFC_SENDTARGETS_ALL = 0x00000100,
139 IFC_SENDTARGETS_SINGLE = 0x00000200,
140};
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,
195 CMDSN_MAXCMDSN_OVERRUN = 3,
196};
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,
232};
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] */
247 u32 MaxXmitDataSegmentLength; /* [512..2**24-1] */
248 u8 OFMarker; /* [0,1] == [No,Yes] */
249 u8 IFMarker; /* [0,1] == [No,Yes] */
250 u32 OFMarkInt; /* [1..65535] */
251 u32 IFMarkInt; /* [1..65535] */
252 /*
253 * iSER specific connection parameters
254 */
255 u32 InitiatorRecvDataSegmentLength; /* [512..2**24-1] */
256 u32 TargetRecvDataSegmentLength; /* [512..2**24-1] */
257};
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]*/
278 /*
279 * iSER specific session parameters
280 */
281 u8 RDMAExtensions; /* [0,1] == [No,Yes] */
282};
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 {
301 bool iser;
302 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;
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
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;
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
498struct 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
506struct 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 u16 local_port;
523 int net_size;
524 int login_family;
525 u32 auth_id;
526 u32 conn_flags;
527 /* Used for iscsi_tx_login_rsp() */
528 itt_t login_itt;
529 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;
538#define IPV6_ADDRESS_SPACE 48
539 unsigned char login_ip[IPV6_ADDRESS_SPACE];
540 unsigned char local_ip[IPV6_ADDRESS_SPACE];
541 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;
548 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;
560 void (*orig_data_ready)(struct sock *);
561 void (*orig_state_change)(struct sock *);
562#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;
567 struct delayed_work login_cleanup_work;
568 struct iscsi_login *login;
569 struct timer_list nopin_timer;
570 struct timer_list nopin_response_timer;
571 struct timer_list transport_timer;
572 struct task_struct *login_kworker;
573 /* 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;
585 unsigned int conn_rx_reset_cpumask:1;
586 unsigned int conn_tx_reset_cpumask:1;
587 /* 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;
592 struct iscsi_login *conn_login;
593 struct iscsit_transport *conn_transport;
594 struct iscsi_param_list *param_list;
595 /* Used for per connection auth state machine */
596 void *auth_protocol;
597 void *context;
598 struct iscsi_login_thread_s *login_thread;
599 struct iscsi_portal_group *tpg;
600 struct iscsi_tpg_np *tpg_np;
601 /* 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;
613 u32 maxxmitdatasegmentlength;
614 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 */
633 itt_t init_task_tag;
634 /* 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;
654 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;
660 u64 creation_time;
661 /* 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;
669 /* 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;
696 u8 login_complete;
697 u8 login_failed;
698 bool zero_tsih;
699 char isid[6];
700 u32 cmd_sn;
701 itt_t init_task_tag;
702 u32 initial_exp_statsn;
703 u32 rsp_length;
704 u16 cid;
705 u16 tsih;
706 char req[ISCSI_HDR_LEN];
707 char rsp[ISCSI_HDR_LEN];
708 char *req_buf;
709 char *rsp_buf;
710 struct iscsi_conn *conn;
711 struct iscsi_np *np;
712} ____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
758struct 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;
767 u32 demo_mode_discovery;
768 u32 default_erl;
769 u8 t10_pi;
770 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;
778 bool enabled;
779 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;
790 void *np_context;
791 struct iscsit_transport *np_transport;
792 struct list_head np_list;
793 struct iscsi_tpg_np *tpg_np;
794} ____cacheline_aligned;
795
796struct iscsi_tpg_np {
797 struct iscsi_np *tpg_np;
798 struct iscsi_portal_group *tpg;
799 struct iscsi_tpg_np *tpg_np_parent;
800 struct list_head tpg_np_list;
801 struct list_head tpg_np_child_list;
802 struct list_head tpg_np_parent_list;
803 struct se_tpg_np se_tpg_np;
804 spinlock_t tpg_np_parent_lock;
805 struct completion tpg_np_comp;
806 struct kref tpg_np_kref;
807};
808
809struct iscsi_portal_group {
810 unsigned char tpg_chap_id;
811 /* TPG State */
812 enum tpg_state_table tpg_state;
813 /* Target Portal Group Tag */
814 u16 tpgt;
815 /* Id assigned to target sessions */
816 u16 ntsih;
817 /* Number of active sessions */
818 u32 nsessions;
819 /* Number of Network Portals available for this TPG */
820 u32 num_tpg_nps;
821 /* Per TPG LIO specific session ID. */
822 u32 sid;
823 /* Spinlock for adding/removing Network Portals */
824 spinlock_t tpg_np_lock;
825 spinlock_t tpg_state_lock;
826 struct se_portal_group tpg_se_tpg;
827 struct mutex tpg_access_lock;
828 struct semaphore np_login_sem;
829 struct iscsi_tpg_attrib tpg_attrib;
830 struct iscsi_node_auth tpg_demo_auth;
831 /* Pointer to default list of iSCSI parameters for TPG */
832 struct iscsi_param_list *param_list;
833 struct iscsi_tiqn *tpg_tiqn;
834 struct list_head tpg_gnp_list;
835 struct list_head tpg_list;
836} ____cacheline_aligned;
837
838struct iscsi_wwn_stat_grps {
839 struct config_group iscsi_stat_group;
840 struct config_group iscsi_instance_group;
841 struct config_group iscsi_sess_err_group;
842 struct config_group iscsi_tgt_attr_group;
843 struct config_group iscsi_login_stats_group;
844 struct config_group iscsi_logout_stats_group;
845};
846
847struct iscsi_tiqn {
848#define ISCSI_IQN_LEN 224
849 unsigned char tiqn[ISCSI_IQN_LEN];
850 enum tiqn_state_table tiqn_state;
851 int tiqn_access_count;
852 u32 tiqn_active_tpgs;
853 u32 tiqn_ntpgs;
854 u32 tiqn_num_tpg_nps;
855 u32 tiqn_nsessions;
856 struct list_head tiqn_list;
857 struct list_head tiqn_tpg_list;
858 spinlock_t tiqn_state_lock;
859 spinlock_t tiqn_tpg_lock;
860 struct se_wwn tiqn_wwn;
861 struct iscsi_wwn_stat_grps tiqn_stat_grps;
862 int tiqn_index;
863 struct iscsi_sess_err_stats sess_err_stats;
864 struct iscsi_login_stats login_stats;
865 struct iscsi_logout_stats logout_stats;
866} ____cacheline_aligned;
867
868struct iscsit_global {
869 /* In core shutdown */
870 u32 in_shutdown;
871 u32 active_ts;
872 /* Unique identifier used for the authentication daemon */
873 u32 auth_id;
874 u32 inactive_ts;
875 /* Thread Set bitmap count */
876 int ts_bitmap_count;
877 /* Thread Set bitmap pointer */
878 unsigned long *ts_bitmap;
879 /* Used for iSCSI discovery session authentication */
880 struct iscsi_node_acl discovery_acl;
881 struct iscsi_portal_group *discovery_tpg;
882};
883
884#endif /* ISCSI_TARGET_CORE_H */