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