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