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