1 #ifndef TARGET_CORE_BASE_H
2 #define TARGET_CORE_BASE_H
3 
4 #include <linux/in.h>
5 #include <linux/configfs.h>
6 #include <linux/dma-mapping.h>
7 #include <linux/blkdev.h>
8 #include <linux/percpu_ida.h>
9 #include <scsi/scsi_cmnd.h>
10 #include <net/sock.h>
11 #include <net/tcp.h>
12 
13 #define TARGET_CORE_MOD_VERSION		"v4.1.0"
14 #define TARGET_CORE_VERSION		TARGET_CORE_MOD_VERSION
15 
16 /* Maximum Number of LUNs per Target Portal Group */
17 /* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
18 #define TRANSPORT_MAX_LUNS_PER_TPG		256
19 /*
20  * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
21  *
22  * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
23  * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
24  * 16-byte CDBs by default and require an extra allocation for
25  * 32-byte CDBs to because of legacy issues.
26  *
27  * Within TCM Core there are no such legacy limitiations, so we go ahead
28  * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
29  * within all TCM Core and subsystem plugin code.
30  */
31 #define TCM_MAX_COMMAND_SIZE			32
32 /*
33  * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
34  * defined 96, but the real limit is 252 (or 260 including the header)
35  */
36 #define TRANSPORT_SENSE_BUFFER			SCSI_SENSE_BUFFERSIZE
37 /* Used by transport_send_check_condition_and_sense() */
38 #define SPC_SENSE_KEY_OFFSET			2
39 #define SPC_ADD_SENSE_LEN_OFFSET		7
40 #define SPC_DESC_TYPE_OFFSET			8
41 #define SPC_ADDITIONAL_DESC_LEN_OFFSET		9
42 #define SPC_VALIDITY_OFFSET			10
43 #define SPC_ASC_KEY_OFFSET			12
44 #define SPC_ASCQ_KEY_OFFSET			13
45 #define TRANSPORT_IQN_LEN			224
46 /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
47 #define LU_GROUP_NAME_BUF			256
48 /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
49 #define TG_PT_GROUP_NAME_BUF			256
50 /* Used to parse VPD into struct t10_vpd */
51 #define VPD_TMP_BUF_SIZE			254
52 /* Used by transport_generic_cmd_sequencer() */
53 #define READ_BLOCK_LEN          		6
54 #define READ_CAP_LEN            		8
55 #define READ_POSITION_LEN       		20
56 #define INQUIRY_LEN				36
57 /* Used by transport_get_inquiry_vpd_serial() */
58 #define INQUIRY_VPD_SERIAL_LEN			254
59 /* Used by transport_get_inquiry_vpd_device_ident() */
60 #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN	254
61 
62 /* Attempts before moving from SHORT to LONG */
63 #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD	3
64 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT	3  /* In milliseconds */
65 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG	10 /* In milliseconds */
66 
67 #define PYX_TRANSPORT_STATUS_INTERVAL		5 /* In seconds */
68 
69 /* struct se_dev_attrib sanity values */
70 /* Default max_unmap_lba_count */
71 #define DA_MAX_UNMAP_LBA_COUNT			0
72 /* Default max_unmap_block_desc_count */
73 #define DA_MAX_UNMAP_BLOCK_DESC_COUNT		0
74 /* Default unmap_granularity */
75 #define DA_UNMAP_GRANULARITY_DEFAULT		0
76 /* Default unmap_granularity_alignment */
77 #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT	0
78 /* Default max_write_same_len, disabled by default */
79 #define DA_MAX_WRITE_SAME_LEN			0
80 /* Default max transfer length */
81 #define DA_FABRIC_MAX_SECTORS			8192
82 /* Use a model alias based on the configfs backend device name */
83 #define DA_EMULATE_MODEL_ALIAS			0
84 /* Emulation for Direct Page Out */
85 #define DA_EMULATE_DPO				0
86 /* Emulation for Forced Unit Access WRITEs */
87 #define DA_EMULATE_FUA_WRITE			1
88 /* Emulation for Forced Unit Access READs */
89 #define DA_EMULATE_FUA_READ			0
90 /* Emulation for WriteCache and SYNCHRONIZE_CACHE */
91 #define DA_EMULATE_WRITE_CACHE			0
92 /* Emulation for UNIT ATTENTION Interlock Control */
93 #define DA_EMULATE_UA_INTLLCK_CTRL		0
94 /* Emulation for TASK_ABORTED status (TAS) by default */
95 #define DA_EMULATE_TAS				1
96 /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
97 #define DA_EMULATE_TPU				0
98 /*
99  * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
100  * block/blk-lib.c:blkdev_issue_discard()
101  */
102 #define DA_EMULATE_TPWS				0
103 /* Emulation for CompareAndWrite (AtomicTestandSet) by default */
104 #define DA_EMULATE_CAW				1
105 /* Emulation for 3rd Party Copy (ExtendedCopy) by default */
106 #define DA_EMULATE_3PC				1
107 /* No Emulation for PSCSI by default */
108 #define DA_EMULATE_ALUA				0
109 /* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
110 #define DA_ENFORCE_PR_ISIDS			1
111 /* Force SPC-3 PR Activate Persistence across Target Power Loss */
112 #define DA_FORCE_PR_APTPL			0
113 #define DA_STATUS_MAX_SECTORS_MIN		16
114 #define DA_STATUS_MAX_SECTORS_MAX		8192
115 /* By default don't report non-rotating (solid state) medium */
116 #define DA_IS_NONROT				0
117 /* Queue Algorithm Modifier default for restricted reordering in control mode page */
118 #define DA_EMULATE_REST_REORD			0
119 
120 #define SE_INQUIRY_BUF				1024
121 #define SE_MODE_PAGE_BUF			512
122 #define SE_SENSE_BUF				96
123 
124 /* struct se_hba->hba_flags */
125 enum hba_flags_table {
126 	HBA_FLAGS_INTERNAL_USE	= 0x01,
127 	HBA_FLAGS_PSCSI_MODE	= 0x02,
128 };
129 
130 /* struct se_lun->lun_status */
131 enum transport_lun_status_table {
132 	TRANSPORT_LUN_STATUS_FREE = 0,
133 	TRANSPORT_LUN_STATUS_ACTIVE = 1,
134 };
135 
136 /* struct se_portal_group->se_tpg_type */
137 enum transport_tpg_type_table {
138 	TRANSPORT_TPG_TYPE_NORMAL = 0,
139 	TRANSPORT_TPG_TYPE_DISCOVERY = 1,
140 };
141 
142 /* Special transport agnostic struct se_cmd->t_states */
143 enum transport_state_table {
144 	TRANSPORT_NO_STATE	= 0,
145 	TRANSPORT_NEW_CMD	= 1,
146 	TRANSPORT_WRITE_PENDING	= 3,
147 	TRANSPORT_PROCESSING	= 5,
148 	TRANSPORT_COMPLETE	= 6,
149 	TRANSPORT_ISTATE_PROCESSING = 11,
150 	TRANSPORT_COMPLETE_QF_WP = 18,
151 	TRANSPORT_COMPLETE_QF_OK = 19,
152 };
153 
154 /* Used for struct se_cmd->se_cmd_flags */
155 enum se_cmd_flags_table {
156 	SCF_SUPPORTED_SAM_OPCODE	= 0x00000001,
157 	SCF_TRANSPORT_TASK_SENSE	= 0x00000002,
158 	SCF_EMULATED_TASK_SENSE		= 0x00000004,
159 	SCF_SCSI_DATA_CDB		= 0x00000008,
160 	SCF_SCSI_TMR_CDB		= 0x00000010,
161 	SCF_FUA				= 0x00000080,
162 	SCF_SE_LUN_CMD			= 0x00000100,
163 	SCF_BIDI			= 0x00000400,
164 	SCF_SENT_CHECK_CONDITION	= 0x00000800,
165 	SCF_OVERFLOW_BIT		= 0x00001000,
166 	SCF_UNDERFLOW_BIT		= 0x00002000,
167 	SCF_SEND_DELAYED_TAS		= 0x00004000,
168 	SCF_ALUA_NON_OPTIMIZED		= 0x00008000,
169 	SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00020000,
170 	SCF_ACK_KREF			= 0x00040000,
171 	SCF_COMPARE_AND_WRITE		= 0x00080000,
172 	SCF_COMPARE_AND_WRITE_POST	= 0x00100000,
173 	SCF_CMD_XCOPY_PASSTHROUGH	= 0x00200000,
174 };
175 
176 /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
177 enum transport_lunflags_table {
178 	TRANSPORT_LUNFLAGS_NO_ACCESS		= 0x00,
179 	TRANSPORT_LUNFLAGS_INITIATOR_ACCESS	= 0x01,
180 	TRANSPORT_LUNFLAGS_READ_ONLY		= 0x02,
181 	TRANSPORT_LUNFLAGS_READ_WRITE		= 0x04,
182 };
183 
184 /*
185  * Used by transport_send_check_condition_and_sense()
186  * to signal which ASC/ASCQ sense payload should be built.
187  */
188 typedef unsigned __bitwise__ sense_reason_t;
189 
190 enum tcm_sense_reason_table {
191 #define R(x)	(__force sense_reason_t )(x)
192 	TCM_NO_SENSE				= R(0x00),
193 	TCM_NON_EXISTENT_LUN			= R(0x01),
194 	TCM_UNSUPPORTED_SCSI_OPCODE		= R(0x02),
195 	TCM_INCORRECT_AMOUNT_OF_DATA		= R(0x03),
196 	TCM_UNEXPECTED_UNSOLICITED_DATA		= R(0x04),
197 	TCM_SERVICE_CRC_ERROR			= R(0x05),
198 	TCM_SNACK_REJECTED			= R(0x06),
199 	TCM_SECTOR_COUNT_TOO_MANY		= R(0x07),
200 	TCM_INVALID_CDB_FIELD			= R(0x08),
201 	TCM_INVALID_PARAMETER_LIST		= R(0x09),
202 	TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE	= R(0x0a),
203 	TCM_UNKNOWN_MODE_PAGE			= R(0x0b),
204 	TCM_WRITE_PROTECTED			= R(0x0c),
205 	TCM_CHECK_CONDITION_ABORT_CMD		= R(0x0d),
206 	TCM_CHECK_CONDITION_UNIT_ATTENTION	= R(0x0e),
207 	TCM_CHECK_CONDITION_NOT_READY		= R(0x0f),
208 	TCM_RESERVATION_CONFLICT		= R(0x10),
209 	TCM_ADDRESS_OUT_OF_RANGE		= R(0x11),
210 	TCM_OUT_OF_RESOURCES			= R(0x12),
211 	TCM_PARAMETER_LIST_LENGTH_ERROR		= R(0x13),
212 	TCM_MISCOMPARE_VERIFY			= R(0x14),
213 	TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED	= R(0x15),
214 	TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED	= R(0x16),
215 	TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED	= R(0x17),
216 #undef R
217 };
218 
219 enum target_sc_flags_table {
220 	TARGET_SCF_BIDI_OP		= 0x01,
221 	TARGET_SCF_ACK_KREF		= 0x02,
222 	TARGET_SCF_UNKNOWN_SIZE		= 0x04,
223 };
224 
225 /* fabric independent task management function values */
226 enum tcm_tmreq_table {
227 	TMR_ABORT_TASK		= 1,
228 	TMR_ABORT_TASK_SET	= 2,
229 	TMR_CLEAR_ACA		= 3,
230 	TMR_CLEAR_TASK_SET	= 4,
231 	TMR_LUN_RESET		= 5,
232 	TMR_TARGET_WARM_RESET	= 6,
233 	TMR_TARGET_COLD_RESET	= 7,
234 };
235 
236 /* fabric independent task management response values */
237 enum tcm_tmrsp_table {
238 	TMR_FUNCTION_FAILED		= 0,
239 	TMR_FUNCTION_COMPLETE		= 1,
240 	TMR_TASK_DOES_NOT_EXIST		= 2,
241 	TMR_LUN_DOES_NOT_EXIST		= 3,
242 	TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED	= 4,
243 	TMR_FUNCTION_REJECTED		= 5,
244 };
245 
246 /*
247  * Used for target SCSI statistics
248  */
249 typedef enum {
250 	SCSI_INST_INDEX,
251 	SCSI_DEVICE_INDEX,
252 	SCSI_AUTH_INTR_INDEX,
253 	SCSI_INDEX_TYPE_MAX
254 } scsi_index_t;
255 
256 struct se_cmd;
257 
258 struct t10_alua_lba_map_member {
259 	struct list_head lba_map_mem_list;
260 	int lba_map_mem_alua_state;
261 	int lba_map_mem_alua_pg_id;
262 };
263 
264 struct t10_alua_lba_map {
265 	u64 lba_map_first_lba;
266 	u64 lba_map_last_lba;
267 	struct list_head lba_map_list;
268 	struct list_head lba_map_mem_list;
269 };
270 
271 struct t10_alua {
272 	/* ALUA Target Port Group ID */
273 	u16	alua_tg_pt_gps_counter;
274 	u32	alua_tg_pt_gps_count;
275 	/* Referrals support */
276 	spinlock_t lba_map_lock;
277 	u32     lba_map_segment_size;
278 	u32     lba_map_segment_multiplier;
279 	struct list_head lba_map_list;
280 	spinlock_t tg_pt_gps_lock;
281 	struct se_device *t10_dev;
282 	/* Used for default ALUA Target Port Group */
283 	struct t10_alua_tg_pt_gp *default_tg_pt_gp;
284 	/* Used for default ALUA Target Port Group ConfigFS group */
285 	struct config_group alua_tg_pt_gps_group;
286 	struct list_head tg_pt_gps_list;
287 };
288 
289 struct t10_alua_lu_gp {
290 	u16	lu_gp_id;
291 	int	lu_gp_valid_id;
292 	u32	lu_gp_members;
293 	atomic_t lu_gp_ref_cnt;
294 	spinlock_t lu_gp_lock;
295 	struct config_group lu_gp_group;
296 	struct list_head lu_gp_node;
297 	struct list_head lu_gp_mem_list;
298 };
299 
300 struct t10_alua_lu_gp_member {
301 	bool lu_gp_assoc;
302 	atomic_t lu_gp_mem_ref_cnt;
303 	spinlock_t lu_gp_mem_lock;
304 	struct t10_alua_lu_gp *lu_gp;
305 	struct se_device *lu_gp_mem_dev;
306 	struct list_head lu_gp_mem_list;
307 };
308 
309 struct t10_alua_tg_pt_gp {
310 	u16	tg_pt_gp_id;
311 	int	tg_pt_gp_valid_id;
312 	int	tg_pt_gp_alua_supported_states;
313 	int	tg_pt_gp_alua_pending_state;
314 	int	tg_pt_gp_alua_previous_state;
315 	int	tg_pt_gp_alua_access_status;
316 	int	tg_pt_gp_alua_access_type;
317 	int	tg_pt_gp_nonop_delay_msecs;
318 	int	tg_pt_gp_trans_delay_msecs;
319 	int	tg_pt_gp_implicit_trans_secs;
320 	int	tg_pt_gp_pref;
321 	int	tg_pt_gp_write_metadata;
322 	u32	tg_pt_gp_members;
323 	atomic_t tg_pt_gp_alua_access_state;
324 	atomic_t tg_pt_gp_ref_cnt;
325 	spinlock_t tg_pt_gp_lock;
326 	struct mutex tg_pt_gp_md_mutex;
327 	struct se_device *tg_pt_gp_dev;
328 	struct config_group tg_pt_gp_group;
329 	struct list_head tg_pt_gp_list;
330 	struct list_head tg_pt_gp_mem_list;
331 	struct se_port *tg_pt_gp_alua_port;
332 	struct se_node_acl *tg_pt_gp_alua_nacl;
333 	struct delayed_work tg_pt_gp_transition_work;
334 	struct completion *tg_pt_gp_transition_complete;
335 };
336 
337 struct t10_alua_tg_pt_gp_member {
338 	bool tg_pt_gp_assoc;
339 	atomic_t tg_pt_gp_mem_ref_cnt;
340 	spinlock_t tg_pt_gp_mem_lock;
341 	struct t10_alua_tg_pt_gp *tg_pt_gp;
342 	struct se_port *tg_pt;
343 	struct list_head tg_pt_gp_mem_list;
344 };
345 
346 struct t10_vpd {
347 	unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
348 	int protocol_identifier_set;
349 	u32 protocol_identifier;
350 	u32 device_identifier_code_set;
351 	u32 association;
352 	u32 device_identifier_type;
353 	struct list_head vpd_list;
354 };
355 
356 struct t10_wwn {
357 	char vendor[8];
358 	char model[16];
359 	char revision[4];
360 	char unit_serial[INQUIRY_VPD_SERIAL_LEN];
361 	spinlock_t t10_vpd_lock;
362 	struct se_device *t10_dev;
363 	struct config_group t10_wwn_group;
364 	struct list_head t10_vpd_list;
365 };
366 
367 struct t10_pr_registration {
368 	/* Used for fabrics that contain WWN+ISID */
369 #define PR_REG_ISID_LEN				16
370 	/* PR_REG_ISID_LEN + ',i,0x' */
371 #define PR_REG_ISID_ID_LEN			(PR_REG_ISID_LEN + 5)
372 	char pr_reg_isid[PR_REG_ISID_LEN];
373 	/* Used during APTPL metadata reading */
374 #define PR_APTPL_MAX_IPORT_LEN			256
375 	unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
376 	/* Used during APTPL metadata reading */
377 #define PR_APTPL_MAX_TPORT_LEN			256
378 	unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
379 	u16 pr_aptpl_rpti;
380 	u16 pr_reg_tpgt;
381 	/* Reservation effects all target ports */
382 	int pr_reg_all_tg_pt;
383 	/* Activate Persistence across Target Power Loss */
384 	int pr_reg_aptpl;
385 	int pr_res_holder;
386 	int pr_res_type;
387 	int pr_res_scope;
388 	/* Used for fabric initiator WWPNs using a ISID */
389 	bool isid_present_at_reg;
390 	u32 pr_res_mapped_lun;
391 	u32 pr_aptpl_target_lun;
392 	u32 pr_res_generation;
393 	u64 pr_reg_bin_isid;
394 	u64 pr_res_key;
395 	atomic_t pr_res_holders;
396 	struct se_node_acl *pr_reg_nacl;
397 	struct se_dev_entry *pr_reg_deve;
398 	struct se_lun *pr_reg_tg_pt_lun;
399 	struct list_head pr_reg_list;
400 	struct list_head pr_reg_abort_list;
401 	struct list_head pr_reg_aptpl_list;
402 	struct list_head pr_reg_atp_list;
403 	struct list_head pr_reg_atp_mem_list;
404 };
405 
406 struct t10_reservation {
407 	/* Reservation effects all target ports */
408 	int pr_all_tg_pt;
409 	/* Activate Persistence across Target Power Loss enabled
410 	 * for SCSI device */
411 	int pr_aptpl_active;
412 #define PR_APTPL_BUF_LEN			8192
413 	u32 pr_generation;
414 	spinlock_t registration_lock;
415 	spinlock_t aptpl_reg_lock;
416 	/*
417 	 * This will always be set by one individual I_T Nexus.
418 	 * However with all_tg_pt=1, other I_T Nexus from the
419 	 * same initiator can access PR reg/res info on a different
420 	 * target port.
421 	 *
422 	 * There is also the 'All Registrants' case, where there is
423 	 * a single *pr_res_holder of the reservation, but all
424 	 * registrations are considered reservation holders.
425 	 */
426 	struct se_node_acl *pr_res_holder;
427 	struct list_head registration_list;
428 	struct list_head aptpl_reg_list;
429 };
430 
431 struct se_tmr_req {
432 	/* Task Management function to be performed */
433 	u8			function;
434 	/* Task Management response to send */
435 	u8			response;
436 	int			call_transport;
437 	/* Reference to ITT that Task Mgmt should be performed */
438 	u32			ref_task_tag;
439 	void 			*fabric_tmr_ptr;
440 	struct se_cmd		*task_cmd;
441 	struct se_device	*tmr_dev;
442 	struct se_lun		*tmr_lun;
443 	struct list_head	tmr_list;
444 };
445 
446 enum target_prot_op {
447 	TARGET_PROT_NORMAL	= 0,
448 	TARGET_PROT_DIN_INSERT	= (1 << 0),
449 	TARGET_PROT_DOUT_INSERT	= (1 << 1),
450 	TARGET_PROT_DIN_STRIP	= (1 << 2),
451 	TARGET_PROT_DOUT_STRIP	= (1 << 3),
452 	TARGET_PROT_DIN_PASS	= (1 << 4),
453 	TARGET_PROT_DOUT_PASS	= (1 << 5),
454 };
455 
456 #define TARGET_PROT_ALL	TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \
457 			TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \
458 			TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS
459 
460 enum target_prot_type {
461 	TARGET_DIF_TYPE0_PROT,
462 	TARGET_DIF_TYPE1_PROT,
463 	TARGET_DIF_TYPE2_PROT,
464 	TARGET_DIF_TYPE3_PROT,
465 };
466 
467 enum target_core_dif_check {
468 	TARGET_DIF_CHECK_GUARD  = 0x1 << 0,
469 	TARGET_DIF_CHECK_APPTAG = 0x1 << 1,
470 	TARGET_DIF_CHECK_REFTAG = 0x1 << 2,
471 };
472 
473 struct se_dif_v1_tuple {
474 	__be16			guard_tag;
475 	__be16			app_tag;
476 	__be32			ref_tag;
477 };
478 
479 struct se_cmd {
480 	/* SAM response code being sent to initiator */
481 	u8			scsi_status;
482 	u8			scsi_asc;
483 	u8			scsi_ascq;
484 	u16			scsi_sense_length;
485 	/* Delay for ALUA Active/NonOptimized state access in milliseconds */
486 	int			alua_nonop_delay;
487 	/* See include/linux/dma-mapping.h */
488 	enum dma_data_direction	data_direction;
489 	/* For SAM Task Attribute */
490 	int			sam_task_attr;
491 	/* Used for se_sess->sess_tag_pool */
492 	unsigned int		map_tag;
493 	/* Transport protocol dependent state, see transport_state_table */
494 	enum transport_state_table t_state;
495 	unsigned		cmd_wait_set:1;
496 	unsigned		unknown_data_length:1;
497 	/* See se_cmd_flags_table */
498 	u32			se_cmd_flags;
499 	u32			se_ordered_id;
500 	/* Total size in bytes associated with command */
501 	u32			data_length;
502 	u32			residual_count;
503 	u32			orig_fe_lun;
504 	/* Persistent Reservation key */
505 	u64			pr_res_key;
506 	/* Used for sense data */
507 	void			*sense_buffer;
508 	struct list_head	se_delayed_node;
509 	struct list_head	se_qf_node;
510 	struct se_device      *se_dev;
511 	struct se_dev_entry   *se_deve;
512 	struct se_lun		*se_lun;
513 	/* Only used for internal passthrough and legacy TCM fabric modules */
514 	struct se_session	*se_sess;
515 	struct se_tmr_req	*se_tmr_req;
516 	struct list_head	se_cmd_list;
517 	struct completion	cmd_wait_comp;
518 	struct kref		cmd_kref;
519 	struct target_core_fabric_ops *se_tfo;
520 	sense_reason_t		(*execute_cmd)(struct se_cmd *);
521 	sense_reason_t		(*execute_rw)(struct se_cmd *, struct scatterlist *,
522 					      u32, enum dma_data_direction);
523 	sense_reason_t (*transport_complete_callback)(struct se_cmd *);
524 
525 	unsigned char		*t_task_cdb;
526 	unsigned char		__t_task_cdb[TCM_MAX_COMMAND_SIZE];
527 	unsigned long long	t_task_lba;
528 	unsigned int		t_task_nolb;
529 	unsigned int		transport_state;
530 #define CMD_T_ABORTED		(1 << 0)
531 #define CMD_T_ACTIVE		(1 << 1)
532 #define CMD_T_COMPLETE		(1 << 2)
533 #define CMD_T_SENT		(1 << 4)
534 #define CMD_T_STOP		(1 << 5)
535 #define CMD_T_DEV_ACTIVE	(1 << 7)
536 #define CMD_T_REQUEST_STOP	(1 << 8)
537 #define CMD_T_BUSY		(1 << 9)
538 	spinlock_t		t_state_lock;
539 	struct completion	t_transport_stop_comp;
540 
541 	struct work_struct	work;
542 
543 	struct scatterlist	*t_data_sg;
544 	struct scatterlist	*t_data_sg_orig;
545 	unsigned int		t_data_nents;
546 	unsigned int		t_data_nents_orig;
547 	void			*t_data_vmap;
548 	struct scatterlist	*t_bidi_data_sg;
549 	unsigned int		t_bidi_data_nents;
550 
551 	struct list_head	state_list;
552 	bool			state_active;
553 
554 	/* old task stop completion, consider merging with some of the above */
555 	struct completion	task_stop_comp;
556 
557 	/* backend private data */
558 	void			*priv;
559 
560 	/* Used for lun->lun_ref counting */
561 	int			lun_ref_active;
562 
563 	/* DIF related members */
564 	enum target_prot_op	prot_op;
565 	enum target_prot_type	prot_type;
566 	u8			prot_checks;
567 	u32			prot_length;
568 	u32			reftag_seed;
569 	struct scatterlist	*t_prot_sg;
570 	unsigned int		t_prot_nents;
571 	sense_reason_t		pi_err;
572 	sector_t		bad_sector;
573 	bool			prot_pto;
574 };
575 
576 struct se_ua {
577 	u8			ua_asc;
578 	u8			ua_ascq;
579 	struct se_node_acl	*ua_nacl;
580 	struct list_head	ua_nacl_list;
581 };
582 
583 struct se_node_acl {
584 	char			initiatorname[TRANSPORT_IQN_LEN];
585 	/* Used to signal demo mode created ACL, disabled by default */
586 	bool			dynamic_node_acl;
587 	bool			acl_stop:1;
588 	u32			queue_depth;
589 	u32			acl_index;
590 #define MAX_ACL_TAG_SIZE 64
591 	char			acl_tag[MAX_ACL_TAG_SIZE];
592 	/* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
593 	atomic_t		acl_pr_ref_count;
594 	struct se_dev_entry	**device_list;
595 	struct se_session	*nacl_sess;
596 	struct se_portal_group *se_tpg;
597 	spinlock_t		device_list_lock;
598 	spinlock_t		nacl_sess_lock;
599 	struct config_group	acl_group;
600 	struct config_group	acl_attrib_group;
601 	struct config_group	acl_auth_group;
602 	struct config_group	acl_param_group;
603 	struct config_group	acl_fabric_stat_group;
604 	struct config_group	*acl_default_groups[5];
605 	struct list_head	acl_list;
606 	struct list_head	acl_sess_list;
607 	struct completion	acl_free_comp;
608 	struct kref		acl_kref;
609 };
610 
611 struct se_session {
612 	unsigned		sess_tearing_down:1;
613 	u64			sess_bin_isid;
614 	enum target_prot_op	sup_prot_ops;
615 	struct se_node_acl	*se_node_acl;
616 	struct se_portal_group *se_tpg;
617 	void			*fabric_sess_ptr;
618 	struct list_head	sess_list;
619 	struct list_head	sess_acl_list;
620 	struct list_head	sess_cmd_list;
621 	struct list_head	sess_wait_list;
622 	spinlock_t		sess_cmd_lock;
623 	struct kref		sess_kref;
624 	void			*sess_cmd_map;
625 	struct percpu_ida	sess_tag_pool;
626 };
627 
628 struct se_device;
629 struct se_transform_info;
630 struct scatterlist;
631 
632 struct se_ml_stat_grps {
633 	struct config_group	stat_group;
634 	struct config_group	scsi_auth_intr_group;
635 	struct config_group	scsi_att_intr_port_group;
636 };
637 
638 struct se_lun_acl {
639 	char			initiatorname[TRANSPORT_IQN_LEN];
640 	u32			mapped_lun;
641 	struct se_node_acl	*se_lun_nacl;
642 	struct se_lun		*se_lun;
643 	struct list_head	lacl_list;
644 	struct config_group	se_lun_group;
645 	struct se_ml_stat_grps	ml_stat_grps;
646 };
647 
648 struct se_dev_entry {
649 	bool			def_pr_registered;
650 	/* See transport_lunflags_table */
651 	u32			lun_flags;
652 	u32			mapped_lun;
653 	u32			total_cmds;
654 	u64			pr_res_key;
655 	u64			creation_time;
656 	u32			attach_count;
657 	u64			read_bytes;
658 	u64			write_bytes;
659 	atomic_t		ua_count;
660 	/* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
661 	atomic_t		pr_ref_count;
662 	struct se_lun_acl	*se_lun_acl;
663 	spinlock_t		ua_lock;
664 	struct se_lun		*se_lun;
665 	struct list_head	alua_port_list;
666 	struct list_head	ua_list;
667 };
668 
669 struct se_dev_attrib {
670 	int		emulate_model_alias;
671 	int		emulate_dpo;
672 	int		emulate_fua_write;
673 	int		emulate_fua_read;
674 	int		emulate_write_cache;
675 	int		emulate_ua_intlck_ctrl;
676 	int		emulate_tas;
677 	int		emulate_tpu;
678 	int		emulate_tpws;
679 	int		emulate_caw;
680 	int		emulate_3pc;
681 	int		pi_prot_format;
682 	enum target_prot_type pi_prot_type;
683 	enum target_prot_type hw_pi_prot_type;
684 	int		enforce_pr_isids;
685 	int		force_pr_aptpl;
686 	int		is_nonrot;
687 	int		emulate_rest_reord;
688 	u32		hw_block_size;
689 	u32		block_size;
690 	u32		hw_max_sectors;
691 	u32		fabric_max_sectors;
692 	u32		optimal_sectors;
693 	u32		hw_queue_depth;
694 	u32		queue_depth;
695 	u32		max_unmap_lba_count;
696 	u32		max_unmap_block_desc_count;
697 	u32		unmap_granularity;
698 	u32		unmap_granularity_alignment;
699 	u32		max_write_same_len;
700 	u32		max_bytes_per_io;
701 	struct se_device *da_dev;
702 	struct config_group da_group;
703 };
704 
705 struct se_port_stat_grps {
706 	struct config_group stat_group;
707 	struct config_group scsi_port_group;
708 	struct config_group scsi_tgt_port_group;
709 	struct config_group scsi_transport_group;
710 };
711 
712 struct se_lun {
713 #define SE_LUN_LINK_MAGIC			0xffff7771
714 	u32			lun_link_magic;
715 	/* See transport_lun_status_table */
716 	enum transport_lun_status_table lun_status;
717 	u32			lun_access;
718 	u32			lun_flags;
719 	u32			unpacked_lun;
720 	atomic_t		lun_acl_count;
721 	spinlock_t		lun_acl_lock;
722 	spinlock_t		lun_sep_lock;
723 	struct completion	lun_shutdown_comp;
724 	struct list_head	lun_acl_list;
725 	struct se_device	*lun_se_dev;
726 	struct se_port		*lun_sep;
727 	struct config_group	lun_group;
728 	struct se_port_stat_grps port_stat_grps;
729 	struct completion	lun_ref_comp;
730 	struct percpu_ref	lun_ref;
731 };
732 
733 struct se_dev_stat_grps {
734 	struct config_group stat_group;
735 	struct config_group scsi_dev_group;
736 	struct config_group scsi_tgt_dev_group;
737 	struct config_group scsi_lu_group;
738 };
739 
740 struct se_device {
741 #define SE_DEV_LINK_MAGIC			0xfeeddeef
742 	u32			dev_link_magic;
743 	/* RELATIVE TARGET PORT IDENTIFER Counter */
744 	u16			dev_rpti_counter;
745 	/* Used for SAM Task Attribute ordering */
746 	u32			dev_cur_ordered_id;
747 	u32			dev_flags;
748 #define DF_CONFIGURED				0x00000001
749 #define DF_FIRMWARE_VPD_UNIT_SERIAL		0x00000002
750 #define DF_EMULATED_VPD_UNIT_SERIAL		0x00000004
751 #define DF_USING_UDEV_PATH			0x00000008
752 #define DF_USING_ALIAS				0x00000010
753 	u32			dev_port_count;
754 	/* Physical device queue depth */
755 	u32			queue_depth;
756 	/* Used for SPC-2 reservations enforce of ISIDs */
757 	u64			dev_res_bin_isid;
758 	/* Pointer to transport specific device structure */
759 	u32			dev_index;
760 	u64			creation_time;
761 	atomic_long_t		num_resets;
762 	atomic_long_t		num_cmds;
763 	atomic_long_t		read_bytes;
764 	atomic_long_t		write_bytes;
765 	/* Active commands on this virtual SE device */
766 	atomic_t		simple_cmds;
767 	atomic_t		dev_ordered_id;
768 	atomic_t		dev_ordered_sync;
769 	atomic_t		dev_qf_count;
770 	int			export_count;
771 	spinlock_t		delayed_cmd_lock;
772 	spinlock_t		execute_task_lock;
773 	spinlock_t		dev_reservation_lock;
774 	unsigned int		dev_reservation_flags;
775 #define DRF_SPC2_RESERVATIONS			0x00000001
776 #define DRF_SPC2_RESERVATIONS_WITH_ISID		0x00000002
777 	spinlock_t		se_port_lock;
778 	spinlock_t		se_tmr_lock;
779 	spinlock_t		qf_cmd_lock;
780 	struct semaphore	caw_sem;
781 	/* Used for legacy SPC-2 reservationsa */
782 	struct se_node_acl	*dev_reserved_node_acl;
783 	/* Used for ALUA Logical Unit Group membership */
784 	struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
785 	/* Used for SPC-3 Persistent Reservations */
786 	struct t10_pr_registration *dev_pr_res_holder;
787 	struct list_head	dev_sep_list;
788 	struct list_head	dev_tmr_list;
789 	struct workqueue_struct *tmr_wq;
790 	struct work_struct	qf_work_queue;
791 	struct list_head	delayed_cmd_list;
792 	struct list_head	state_list;
793 	struct list_head	qf_cmd_list;
794 	struct list_head	g_dev_node;
795 	/* Pointer to associated SE HBA */
796 	struct se_hba		*se_hba;
797 	/* T10 Inquiry and VPD WWN Information */
798 	struct t10_wwn		t10_wwn;
799 	/* T10 Asymmetric Logical Unit Assignment for Target Ports */
800 	struct t10_alua		t10_alua;
801 	/* T10 SPC-2 + SPC-3 Reservations */
802 	struct t10_reservation	t10_pr;
803 	struct se_dev_attrib	dev_attrib;
804 	struct config_group	dev_group;
805 	struct config_group	dev_pr_group;
806 	struct se_dev_stat_grps dev_stat_grps;
807 #define SE_DEV_ALIAS_LEN 512		/* must be less than PAGE_SIZE */
808 	unsigned char		dev_alias[SE_DEV_ALIAS_LEN];
809 #define SE_UDEV_PATH_LEN 512		/* must be less than PAGE_SIZE */
810 	unsigned char		udev_path[SE_UDEV_PATH_LEN];
811 	/* Pointer to template of function pointers for transport */
812 	struct se_subsystem_api *transport;
813 	/* Linked list for struct se_hba struct se_device list */
814 	struct list_head	dev_list;
815 	struct se_lun		xcopy_lun;
816 	/* Protection Information */
817 	int			prot_length;
818 };
819 
820 struct se_hba {
821 	u16			hba_tpgt;
822 	u32			hba_id;
823 	/* See hba_flags_table */
824 	u32			hba_flags;
825 	/* Virtual iSCSI devices attached. */
826 	u32			dev_count;
827 	u32			hba_index;
828 	/* Pointer to transport specific host structure. */
829 	void			*hba_ptr;
830 	struct list_head	hba_node;
831 	spinlock_t		device_lock;
832 	struct config_group	hba_group;
833 	struct mutex		hba_access_mutex;
834 	struct se_subsystem_api *transport;
835 };
836 
837 struct scsi_port_stats {
838        u64     cmd_pdus;
839        u64     tx_data_octets;
840        u64     rx_data_octets;
841 };
842 
843 struct se_port {
844 	/* RELATIVE TARGET PORT IDENTIFER */
845 	u16		sep_rtpi;
846 	int		sep_tg_pt_secondary_stat;
847 	int		sep_tg_pt_secondary_write_md;
848 	u32		sep_index;
849 	struct scsi_port_stats sep_stats;
850 	/* Used for ALUA Target Port Groups membership */
851 	atomic_t	sep_tg_pt_secondary_offline;
852 	/* Used for PR ALL_TG_PT=1 */
853 	atomic_t	sep_tg_pt_ref_cnt;
854 	spinlock_t	sep_alua_lock;
855 	struct mutex	sep_tg_pt_md_mutex;
856 	struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
857 	struct se_lun *sep_lun;
858 	struct se_portal_group *sep_tpg;
859 	struct list_head sep_alua_list;
860 	struct list_head sep_list;
861 };
862 
863 struct se_tpg_np {
864 	struct se_portal_group *tpg_np_parent;
865 	struct config_group	tpg_np_group;
866 };
867 
868 struct se_portal_group {
869 	/* Type of target portal group, see transport_tpg_type_table */
870 	enum transport_tpg_type_table se_tpg_type;
871 	/* Number of ACLed Initiator Nodes for this TPG */
872 	u32			num_node_acls;
873 	/* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
874 	atomic_t		tpg_pr_ref_count;
875 	/* Spinlock for adding/removing ACLed Nodes */
876 	spinlock_t		acl_node_lock;
877 	/* Spinlock for adding/removing sessions */
878 	spinlock_t		session_lock;
879 	spinlock_t		tpg_lun_lock;
880 	/* Pointer to $FABRIC_MOD portal group */
881 	void			*se_tpg_fabric_ptr;
882 	struct list_head	se_tpg_node;
883 	/* linked list for initiator ACL list */
884 	struct list_head	acl_node_list;
885 	struct se_lun		**tpg_lun_list;
886 	struct se_lun		tpg_virt_lun0;
887 	/* List of TCM sessions associated wth this TPG */
888 	struct list_head	tpg_sess_list;
889 	/* Pointer to $FABRIC_MOD dependent code */
890 	struct target_core_fabric_ops *se_tpg_tfo;
891 	struct se_wwn		*se_tpg_wwn;
892 	struct config_group	tpg_group;
893 	struct config_group	*tpg_default_groups[7];
894 	struct config_group	tpg_lun_group;
895 	struct config_group	tpg_np_group;
896 	struct config_group	tpg_acl_group;
897 	struct config_group	tpg_attrib_group;
898 	struct config_group	tpg_auth_group;
899 	struct config_group	tpg_param_group;
900 };
901 
902 struct se_wwn {
903 	struct target_fabric_configfs *wwn_tf;
904 	struct config_group	wwn_group;
905 	struct config_group	*wwn_default_groups[2];
906 	struct config_group	fabric_stat_group;
907 };
908 
909 static inline void atomic_inc_mb(atomic_t *v)
910 {
911 	smp_mb__before_atomic();
912 	atomic_inc(v);
913 	smp_mb__after_atomic();
914 }
915 
916 static inline void atomic_dec_mb(atomic_t *v)
917 {
918 	smp_mb__before_atomic();
919 	atomic_dec(v);
920 	smp_mb__after_atomic();
921 }
922 
923 #endif /* TARGET_CORE_BASE_H */
924