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