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