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