xref: /linux/include/target/target_core_base.h (revision a086536858ad0eb51c58074af2fc2c89ba9c1f5e)
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 #include "target_core_mib.h"
12 
13 #define TARGET_CORE_MOD_VERSION		"v4.0.0-rc6"
14 #define SHUTDOWN_SIGS	(sigmask(SIGKILL)|sigmask(SIGINT)|sigmask(SIGABRT))
15 
16 /* Used by transport_generic_allocate_iovecs() */
17 #define TRANSPORT_IOV_DATA_BUFFER		5
18 /* Maximum Number of LUNs per Target Portal Group */
19 #define TRANSPORT_MAX_LUNS_PER_TPG		256
20 /*
21  * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
22  *
23  * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
24  * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
25  * 16-byte CDBs by default and require an extra allocation for
26  * 32-byte CDBs to becasue of legacy issues.
27  *
28  * Within TCM Core there are no such legacy limitiations, so we go ahead
29  * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
30  * within all TCM Core and subsystem plugin code.
31  */
32 #define TCM_MAX_COMMAND_SIZE			32
33 /*
34  * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
35  * defined 96, but the real limit is 252 (or 260 including the header)
36  */
37 #define TRANSPORT_SENSE_BUFFER			SCSI_SENSE_BUFFERSIZE
38 /* Used by transport_send_check_condition_and_sense() */
39 #define SPC_SENSE_KEY_OFFSET			2
40 #define SPC_ASC_KEY_OFFSET			12
41 #define SPC_ASCQ_KEY_OFFSET			13
42 #define TRANSPORT_IQN_LEN			224
43 /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
44 #define LU_GROUP_NAME_BUF			256
45 /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
46 #define TG_PT_GROUP_NAME_BUF			256
47 /* Used to parse VPD into struct t10_vpd */
48 #define VPD_TMP_BUF_SIZE			128
49 /* Used by transport_generic_cmd_sequencer() */
50 #define READ_BLOCK_LEN          		6
51 #define READ_CAP_LEN            		8
52 #define READ_POSITION_LEN       		20
53 #define INQUIRY_LEN				36
54 /* Used by transport_get_inquiry_vpd_serial() */
55 #define INQUIRY_VPD_SERIAL_LEN			254
56 /* Used by transport_get_inquiry_vpd_device_ident() */
57 #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN	254
58 
59 /* struct se_hba->hba_flags */
60 enum hba_flags_table {
61 	HBA_FLAGS_INTERNAL_USE	= 0x01,
62 	HBA_FLAGS_PSCSI_MODE	= 0x02,
63 };
64 
65 /* struct se_lun->lun_status */
66 enum transport_lun_status_table {
67 	TRANSPORT_LUN_STATUS_FREE = 0,
68 	TRANSPORT_LUN_STATUS_ACTIVE = 1,
69 };
70 
71 /* struct se_portal_group->se_tpg_type */
72 enum transport_tpg_type_table {
73 	TRANSPORT_TPG_TYPE_NORMAL = 0,
74 	TRANSPORT_TPG_TYPE_DISCOVERY = 1,
75 };
76 
77 /* Used for generate timer flags */
78 enum timer_flags_table {
79 	TF_RUNNING	= 0x01,
80 	TF_STOP		= 0x02,
81 };
82 
83 /* Special transport agnostic struct se_cmd->t_states */
84 enum transport_state_table {
85 	TRANSPORT_NO_STATE	= 0,
86 	TRANSPORT_NEW_CMD	= 1,
87 	TRANSPORT_DEFERRED_CMD	= 2,
88 	TRANSPORT_WRITE_PENDING	= 3,
89 	TRANSPORT_PROCESS_WRITE	= 4,
90 	TRANSPORT_PROCESSING	= 5,
91 	TRANSPORT_COMPLETE_OK	= 6,
92 	TRANSPORT_COMPLETE_FAILURE = 7,
93 	TRANSPORT_COMPLETE_TIMEOUT = 8,
94 	TRANSPORT_PROCESS_TMR	= 9,
95 	TRANSPORT_TMR_COMPLETE	= 10,
96 	TRANSPORT_ISTATE_PROCESSING = 11,
97 	TRANSPORT_ISTATE_PROCESSED = 12,
98 	TRANSPORT_KILL		= 13,
99 	TRANSPORT_REMOVE	= 14,
100 	TRANSPORT_FREE		= 15,
101 	TRANSPORT_NEW_CMD_MAP	= 16,
102 };
103 
104 /* Used for struct se_cmd->se_cmd_flags */
105 enum se_cmd_flags_table {
106 	SCF_SUPPORTED_SAM_OPCODE	= 0x00000001,
107 	SCF_TRANSPORT_TASK_SENSE	= 0x00000002,
108 	SCF_EMULATED_TASK_SENSE		= 0x00000004,
109 	SCF_SCSI_DATA_SG_IO_CDB		= 0x00000008,
110 	SCF_SCSI_CONTROL_SG_IO_CDB	= 0x00000010,
111 	SCF_SCSI_CONTROL_NONSG_IO_CDB	= 0x00000020,
112 	SCF_SCSI_NON_DATA_CDB		= 0x00000040,
113 	SCF_SCSI_CDB_EXCEPTION		= 0x00000080,
114 	SCF_SCSI_RESERVATION_CONFLICT	= 0x00000100,
115 	SCF_CMD_PASSTHROUGH_NOALLOC	= 0x00000200,
116 	SCF_SE_CMD_FAILED		= 0x00000400,
117 	SCF_SE_LUN_CMD			= 0x00000800,
118 	SCF_SE_ALLOW_EOO		= 0x00001000,
119 	SCF_SE_DISABLE_ONLINE_CHECK	= 0x00002000,
120 	SCF_SENT_CHECK_CONDITION	= 0x00004000,
121 	SCF_OVERFLOW_BIT		= 0x00008000,
122 	SCF_UNDERFLOW_BIT		= 0x00010000,
123 	SCF_SENT_DELAYED_TAS		= 0x00020000,
124 	SCF_ALUA_NON_OPTIMIZED		= 0x00040000,
125 	SCF_DELAYED_CMD_FROM_SAM_ATTR	= 0x00080000,
126 	SCF_PASSTHROUGH_SG_TO_MEM	= 0x00100000,
127 	SCF_PASSTHROUGH_CONTIG_TO_SG	= 0x00200000,
128 	SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00400000,
129 	SCF_EMULATE_SYNC_CACHE		= 0x00800000,
130 	SCF_EMULATE_CDB_ASYNC		= 0x01000000,
131 	SCF_EMULATE_SYNC_UNMAP		= 0x02000000
132 };
133 
134 /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
135 enum transport_lunflags_table {
136 	TRANSPORT_LUNFLAGS_NO_ACCESS		= 0x00,
137 	TRANSPORT_LUNFLAGS_INITIATOR_ACCESS	= 0x01,
138 	TRANSPORT_LUNFLAGS_READ_ONLY		= 0x02,
139 	TRANSPORT_LUNFLAGS_READ_WRITE		= 0x04,
140 };
141 
142 /* struct se_device->dev_status */
143 enum transport_device_status_table {
144 	TRANSPORT_DEVICE_ACTIVATED		= 0x01,
145 	TRANSPORT_DEVICE_DEACTIVATED		= 0x02,
146 	TRANSPORT_DEVICE_QUEUE_FULL		= 0x04,
147 	TRANSPORT_DEVICE_SHUTDOWN		= 0x08,
148 	TRANSPORT_DEVICE_OFFLINE_ACTIVATED	= 0x10,
149 	TRANSPORT_DEVICE_OFFLINE_DEACTIVATED	= 0x20,
150 };
151 
152 /*
153  * Used by transport_send_check_condition_and_sense() and se_cmd->scsi_sense_reason
154  * to signal which ASC/ASCQ sense payload should be built.
155  */
156 enum tcm_sense_reason_table {
157 	TCM_NON_EXISTENT_LUN			= 0x01,
158 	TCM_UNSUPPORTED_SCSI_OPCODE		= 0x02,
159 	TCM_INCORRECT_AMOUNT_OF_DATA		= 0x03,
160 	TCM_UNEXPECTED_UNSOLICITED_DATA		= 0x04,
161 	TCM_SERVICE_CRC_ERROR			= 0x05,
162 	TCM_SNACK_REJECTED			= 0x06,
163 	TCM_SECTOR_COUNT_TOO_MANY		= 0x07,
164 	TCM_INVALID_CDB_FIELD			= 0x08,
165 	TCM_INVALID_PARAMETER_LIST		= 0x09,
166 	TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE	= 0x0a,
167 	TCM_UNKNOWN_MODE_PAGE			= 0x0b,
168 	TCM_WRITE_PROTECTED			= 0x0c,
169 	TCM_CHECK_CONDITION_ABORT_CMD		= 0x0d,
170 	TCM_CHECK_CONDITION_UNIT_ATTENTION	= 0x0e,
171 	TCM_CHECK_CONDITION_NOT_READY		= 0x0f,
172 };
173 
174 struct se_obj {
175 	atomic_t obj_access_count;
176 } ____cacheline_aligned;
177 
178 /*
179  * Used by TCM Core internally to signal if ALUA emulation is enabled or
180  * disabled, or running in with TCM/pSCSI passthrough mode
181  */
182 typedef enum {
183 	SPC_ALUA_PASSTHROUGH,
184 	SPC2_ALUA_DISABLED,
185 	SPC3_ALUA_EMULATED
186 } t10_alua_index_t;
187 
188 /*
189  * Used by TCM Core internally to signal if SAM Task Attribute emulation
190  * is enabled or disabled, or running in with TCM/pSCSI passthrough mode
191  */
192 typedef enum {
193 	SAM_TASK_ATTR_PASSTHROUGH,
194 	SAM_TASK_ATTR_UNTAGGED,
195 	SAM_TASK_ATTR_EMULATED
196 } t10_task_attr_index_t;
197 
198 struct se_cmd;
199 
200 struct t10_alua {
201 	t10_alua_index_t alua_type;
202 	/* ALUA Target Port Group ID */
203 	u16	alua_tg_pt_gps_counter;
204 	u32	alua_tg_pt_gps_count;
205 	spinlock_t tg_pt_gps_lock;
206 	struct se_subsystem_dev *t10_sub_dev;
207 	/* Used for default ALUA Target Port Group */
208 	struct t10_alua_tg_pt_gp *default_tg_pt_gp;
209 	/* Used for default ALUA Target Port Group ConfigFS group */
210 	struct config_group alua_tg_pt_gps_group;
211 	int (*alua_state_check)(struct se_cmd *, unsigned char *, u8 *);
212 	struct list_head tg_pt_gps_list;
213 } ____cacheline_aligned;
214 
215 struct t10_alua_lu_gp {
216 	u16	lu_gp_id;
217 	int	lu_gp_valid_id;
218 	u32	lu_gp_members;
219 	atomic_t lu_gp_shutdown;
220 	atomic_t lu_gp_ref_cnt;
221 	spinlock_t lu_gp_lock;
222 	struct config_group lu_gp_group;
223 	struct list_head lu_gp_list;
224 	struct list_head lu_gp_mem_list;
225 } ____cacheline_aligned;
226 
227 struct t10_alua_lu_gp_member {
228 	int lu_gp_assoc:1;
229 	atomic_t lu_gp_mem_ref_cnt;
230 	spinlock_t lu_gp_mem_lock;
231 	struct t10_alua_lu_gp *lu_gp;
232 	struct se_device *lu_gp_mem_dev;
233 	struct list_head lu_gp_mem_list;
234 } ____cacheline_aligned;
235 
236 struct t10_alua_tg_pt_gp {
237 	u16	tg_pt_gp_id;
238 	int	tg_pt_gp_valid_id;
239 	int	tg_pt_gp_alua_access_status;
240 	int	tg_pt_gp_alua_access_type;
241 	int	tg_pt_gp_nonop_delay_msecs;
242 	int	tg_pt_gp_trans_delay_msecs;
243 	int	tg_pt_gp_pref;
244 	int	tg_pt_gp_write_metadata;
245 	/* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
246 #define ALUA_MD_BUF_LEN				1024
247 	u32	tg_pt_gp_md_buf_len;
248 	u32	tg_pt_gp_members;
249 	atomic_t tg_pt_gp_alua_access_state;
250 	atomic_t tg_pt_gp_ref_cnt;
251 	spinlock_t tg_pt_gp_lock;
252 	struct mutex tg_pt_gp_md_mutex;
253 	struct se_subsystem_dev *tg_pt_gp_su_dev;
254 	struct config_group tg_pt_gp_group;
255 	struct list_head tg_pt_gp_list;
256 	struct list_head tg_pt_gp_mem_list;
257 } ____cacheline_aligned;
258 
259 struct t10_alua_tg_pt_gp_member {
260 	int tg_pt_gp_assoc:1;
261 	atomic_t tg_pt_gp_mem_ref_cnt;
262 	spinlock_t tg_pt_gp_mem_lock;
263 	struct t10_alua_tg_pt_gp *tg_pt_gp;
264 	struct se_port *tg_pt;
265 	struct list_head tg_pt_gp_mem_list;
266 } ____cacheline_aligned;
267 
268 struct t10_vpd {
269 	unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
270 	int protocol_identifier_set;
271 	u32 protocol_identifier;
272 	u32 device_identifier_code_set;
273 	u32 association;
274 	u32 device_identifier_type;
275 	struct list_head vpd_list;
276 } ____cacheline_aligned;
277 
278 struct t10_wwn {
279 	unsigned char vendor[8];
280 	unsigned char model[16];
281 	unsigned char revision[4];
282 	unsigned char unit_serial[INQUIRY_VPD_SERIAL_LEN];
283 	spinlock_t t10_vpd_lock;
284 	struct se_subsystem_dev *t10_sub_dev;
285 	struct config_group t10_wwn_group;
286 	struct list_head t10_vpd_list;
287 } ____cacheline_aligned;
288 
289 
290 /*
291  * Used by TCM Core internally to signal if >= SPC-3 peristent reservations
292  * emulation is enabled or disabled, or running in with TCM/pSCSI passthrough
293  * mode
294  */
295 typedef enum {
296 	SPC_PASSTHROUGH,
297 	SPC2_RESERVATIONS,
298 	SPC3_PERSISTENT_RESERVATIONS
299 } t10_reservations_index_t;
300 
301 struct t10_pr_registration {
302 	/* Used for fabrics that contain WWN+ISID */
303 #define PR_REG_ISID_LEN				16
304 	/* PR_REG_ISID_LEN + ',i,0x' */
305 #define PR_REG_ISID_ID_LEN			(PR_REG_ISID_LEN + 5)
306 	char pr_reg_isid[PR_REG_ISID_LEN];
307 	/* Used during APTPL metadata reading */
308 #define PR_APTPL_MAX_IPORT_LEN			256
309 	unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
310 	/* Used during APTPL metadata reading */
311 #define PR_APTPL_MAX_TPORT_LEN			256
312 	unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
313 	/* For writing out live meta data */
314 	unsigned char *pr_aptpl_buf;
315 	u16 pr_aptpl_rpti;
316 	u16 pr_reg_tpgt;
317 	/* Reservation effects all target ports */
318 	int pr_reg_all_tg_pt;
319 	/* Activate Persistence across Target Power Loss */
320 	int pr_reg_aptpl;
321 	int pr_res_holder;
322 	int pr_res_type;
323 	int pr_res_scope;
324 	/* Used for fabric initiator WWPNs using a ISID */
325 	int isid_present_at_reg:1;
326 	u32 pr_res_mapped_lun;
327 	u32 pr_aptpl_target_lun;
328 	u32 pr_res_generation;
329 	u64 pr_reg_bin_isid;
330 	u64 pr_res_key;
331 	atomic_t pr_res_holders;
332 	struct se_node_acl *pr_reg_nacl;
333 	struct se_dev_entry *pr_reg_deve;
334 	struct se_lun *pr_reg_tg_pt_lun;
335 	struct list_head pr_reg_list;
336 	struct list_head pr_reg_abort_list;
337 	struct list_head pr_reg_aptpl_list;
338 	struct list_head pr_reg_atp_list;
339 	struct list_head pr_reg_atp_mem_list;
340 } ____cacheline_aligned;
341 
342 /*
343  * This set of function pointer ops is set based upon SPC3_PERSISTENT_RESERVATIONS,
344  * SPC2_RESERVATIONS or SPC_PASSTHROUGH in drivers/target/target_core_pr.c:
345  * core_setup_reservations()
346  */
347 struct t10_reservation_ops {
348 	int (*t10_reservation_check)(struct se_cmd *, u32 *);
349 	int (*t10_seq_non_holder)(struct se_cmd *, unsigned char *, u32);
350 	int (*t10_pr_register)(struct se_cmd *);
351 	int (*t10_pr_clear)(struct se_cmd *);
352 };
353 
354 struct t10_reservation_template {
355 	/* Reservation effects all target ports */
356 	int pr_all_tg_pt;
357 	/* Activate Persistence across Target Power Loss enabled
358 	 * for SCSI device */
359 	int pr_aptpl_active;
360 	/* Used by struct t10_reservation_template->pr_aptpl_buf_len */
361 #define PR_APTPL_BUF_LEN			8192
362 	u32 pr_aptpl_buf_len;
363 	u32 pr_generation;
364 	t10_reservations_index_t res_type;
365 	spinlock_t registration_lock;
366 	spinlock_t aptpl_reg_lock;
367 	/*
368 	 * This will always be set by one individual I_T Nexus.
369 	 * However with all_tg_pt=1, other I_T Nexus from the
370 	 * same initiator can access PR reg/res info on a different
371 	 * target port.
372 	 *
373 	 * There is also the 'All Registrants' case, where there is
374 	 * a single *pr_res_holder of the reservation, but all
375 	 * registrations are considered reservation holders.
376 	 */
377 	struct se_node_acl *pr_res_holder;
378 	struct list_head registration_list;
379 	struct list_head aptpl_reg_list;
380 	struct t10_reservation_ops pr_ops;
381 } ____cacheline_aligned;
382 
383 struct se_queue_req {
384 	int			state;
385 	void			*cmd;
386 	struct list_head	qr_list;
387 } ____cacheline_aligned;
388 
389 struct se_queue_obj {
390 	atomic_t		queue_cnt;
391 	spinlock_t		cmd_queue_lock;
392 	struct list_head	qobj_list;
393 	wait_queue_head_t	thread_wq;
394 } ____cacheline_aligned;
395 
396 /*
397  * Used one per struct se_cmd to hold all extra struct se_task
398  * metadata.  This structure is setup and allocated in
399  * drivers/target/target_core_transport.c:__transport_alloc_se_cmd()
400  */
401 struct se_transport_task {
402 	unsigned char		*t_task_cdb;
403 	unsigned char		__t_task_cdb[TCM_MAX_COMMAND_SIZE];
404 	unsigned long long	t_task_lba;
405 	int			t_tasks_failed;
406 	int			t_tasks_fua;
407 	int			t_tasks_bidi:1;
408 	u32			t_task_cdbs;
409 	u32			t_tasks_check;
410 	u32			t_tasks_no;
411 	u32			t_tasks_sectors;
412 	u32			t_tasks_se_num;
413 	u32			t_tasks_se_bidi_num;
414 	u32			t_tasks_sg_chained_no;
415 	atomic_t		t_fe_count;
416 	atomic_t		t_se_count;
417 	atomic_t		t_task_cdbs_left;
418 	atomic_t		t_task_cdbs_ex_left;
419 	atomic_t		t_task_cdbs_timeout_left;
420 	atomic_t		t_task_cdbs_sent;
421 	atomic_t		t_transport_aborted;
422 	atomic_t		t_transport_active;
423 	atomic_t		t_transport_complete;
424 	atomic_t		t_transport_queue_active;
425 	atomic_t		t_transport_sent;
426 	atomic_t		t_transport_stop;
427 	atomic_t		t_transport_timeout;
428 	atomic_t		transport_dev_active;
429 	atomic_t		transport_lun_active;
430 	atomic_t		transport_lun_fe_stop;
431 	atomic_t		transport_lun_stop;
432 	spinlock_t		t_state_lock;
433 	struct completion	t_transport_stop_comp;
434 	struct completion	transport_lun_fe_stop_comp;
435 	struct completion	transport_lun_stop_comp;
436 	struct scatterlist	*t_tasks_sg_chained;
437 	struct scatterlist	t_tasks_sg_bounce;
438 	void			*t_task_buf;
439 	/*
440 	 * Used for pre-registered fabric SGL passthrough WRITE and READ
441 	 * with the special SCF_PASSTHROUGH_CONTIG_TO_SG case for TCM_Loop
442 	 * and other HW target mode fabric modules.
443 	 */
444 	struct scatterlist	*t_task_pt_sgl;
445 	struct list_head	*t_mem_list;
446 	/* Used for BIDI READ */
447 	struct list_head	*t_mem_bidi_list;
448 	struct list_head	t_task_list;
449 } ____cacheline_aligned;
450 
451 struct se_task {
452 	unsigned char	task_sense;
453 	struct scatterlist *task_sg;
454 	struct scatterlist *task_sg_bidi;
455 	u8		task_scsi_status;
456 	u8		task_flags;
457 	int		task_error_status;
458 	int		task_state_flags;
459 	int		task_padded_sg:1;
460 	unsigned long long	task_lba;
461 	u32		task_no;
462 	u32		task_sectors;
463 	u32		task_size;
464 	u32		task_sg_num;
465 	u32		task_sg_offset;
466 	enum dma_data_direction	task_data_direction;
467 	struct se_cmd *task_se_cmd;
468 	struct se_device	*se_dev;
469 	struct completion	task_stop_comp;
470 	atomic_t	task_active;
471 	atomic_t	task_execute_queue;
472 	atomic_t	task_timeout;
473 	atomic_t	task_sent;
474 	atomic_t	task_stop;
475 	atomic_t	task_state_active;
476 	struct timer_list	task_timer;
477 	struct se_device *se_obj_ptr;
478 	struct list_head t_list;
479 	struct list_head t_execute_list;
480 	struct list_head t_state_list;
481 } ____cacheline_aligned;
482 
483 #define TASK_CMD(task)	((struct se_cmd *)task->task_se_cmd)
484 #define TASK_DEV(task)	((struct se_device *)task->se_dev)
485 
486 struct se_cmd {
487 	/* SAM response code being sent to initiator */
488 	u8			scsi_status;
489 	u8			scsi_asc;
490 	u8			scsi_ascq;
491 	u8			scsi_sense_reason;
492 	u16			scsi_sense_length;
493 	/* Delay for ALUA Active/NonOptimized state access in milliseconds */
494 	int			alua_nonop_delay;
495 	/* See include/linux/dma-mapping.h */
496 	enum dma_data_direction	data_direction;
497 	/* For SAM Task Attribute */
498 	int			sam_task_attr;
499 	/* Transport protocol dependent state, see transport_state_table */
500 	enum transport_state_table t_state;
501 	/* Transport protocol dependent state for out of order CmdSNs */
502 	int			deferred_t_state;
503 	/* Transport specific error status */
504 	int			transport_error_status;
505 	/* See se_cmd_flags_table */
506 	u32			se_cmd_flags;
507 	u32			se_ordered_id;
508 	/* Total size in bytes associated with command */
509 	u32			data_length;
510 	/* SCSI Presented Data Transfer Length */
511 	u32			cmd_spdtl;
512 	u32			residual_count;
513 	u32			orig_fe_lun;
514 	/* Persistent Reservation key */
515 	u64			pr_res_key;
516 	atomic_t                transport_sent;
517 	/* Used for sense data */
518 	void			*sense_buffer;
519 	struct list_head	se_delayed_list;
520 	struct list_head	se_ordered_list;
521 	struct list_head	se_lun_list;
522 	struct se_device      *se_dev;
523 	struct se_dev_entry   *se_deve;
524 	struct se_device	*se_obj_ptr;
525 	struct se_device	*se_orig_obj_ptr;
526 	struct se_lun		*se_lun;
527 	/* Only used for internal passthrough and legacy TCM fabric modules */
528 	struct se_session	*se_sess;
529 	struct se_tmr_req	*se_tmr_req;
530 	/* t_task is setup to t_task_backstore in transport_init_se_cmd() */
531 	struct se_transport_task *t_task;
532 	struct se_transport_task t_task_backstore;
533 	struct target_core_fabric_ops *se_tfo;
534 	int (*transport_emulate_cdb)(struct se_cmd *);
535 	void (*transport_split_cdb)(unsigned long long, u32 *, unsigned char *);
536 	void (*transport_wait_for_tasks)(struct se_cmd *, int, int);
537 	void (*transport_complete_callback)(struct se_cmd *);
538 } ____cacheline_aligned;
539 
540 #define T_TASK(cmd)     ((struct se_transport_task *)(cmd->t_task))
541 #define CMD_TFO(cmd) ((struct target_core_fabric_ops *)cmd->se_tfo)
542 
543 struct se_tmr_req {
544 	/* Task Management function to be preformed */
545 	u8			function;
546 	/* Task Management response to send */
547 	u8			response;
548 	int			call_transport;
549 	/* Reference to ITT that Task Mgmt should be preformed */
550 	u32			ref_task_tag;
551 	/* 64-bit encoded SAM LUN from $FABRIC_MOD TMR header */
552 	u64			ref_task_lun;
553 	void 			*fabric_tmr_ptr;
554 	struct se_cmd		*task_cmd;
555 	struct se_cmd		*ref_cmd;
556 	struct se_device	*tmr_dev;
557 	struct se_lun		*tmr_lun;
558 	struct list_head	tmr_list;
559 } ____cacheline_aligned;
560 
561 struct se_ua {
562 	u8			ua_asc;
563 	u8			ua_ascq;
564 	struct se_node_acl	*ua_nacl;
565 	struct list_head	ua_dev_list;
566 	struct list_head	ua_nacl_list;
567 } ____cacheline_aligned;
568 
569 struct se_node_acl {
570 	char			initiatorname[TRANSPORT_IQN_LEN];
571 	/* Used to signal demo mode created ACL, disabled by default */
572 	int			dynamic_node_acl:1;
573 	u32			queue_depth;
574 	u32			acl_index;
575 	u64			num_cmds;
576 	u64			read_bytes;
577 	u64			write_bytes;
578 	spinlock_t		stats_lock;
579 	/* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
580 	atomic_t		acl_pr_ref_count;
581 	/* Used for MIB access */
582 	atomic_t		mib_ref_count;
583 	struct se_dev_entry	*device_list;
584 	struct se_session	*nacl_sess;
585 	struct se_portal_group *se_tpg;
586 	spinlock_t		device_list_lock;
587 	spinlock_t		nacl_sess_lock;
588 	struct config_group	acl_group;
589 	struct config_group	acl_attrib_group;
590 	struct config_group	acl_auth_group;
591 	struct config_group	acl_param_group;
592 	struct config_group	*acl_default_groups[4];
593 	struct list_head	acl_list;
594 	struct list_head	acl_sess_list;
595 } ____cacheline_aligned;
596 
597 struct se_session {
598 	/* Used for MIB access */
599 	atomic_t		mib_ref_count;
600 	u64			sess_bin_isid;
601 	struct se_node_acl	*se_node_acl;
602 	struct se_portal_group *se_tpg;
603 	void			*fabric_sess_ptr;
604 	struct list_head	sess_list;
605 	struct list_head	sess_acl_list;
606 } ____cacheline_aligned;
607 
608 #define SE_SESS(cmd)		((struct se_session *)(cmd)->se_sess)
609 #define SE_NODE_ACL(sess)	((struct se_node_acl *)(sess)->se_node_acl)
610 
611 struct se_device;
612 struct se_transform_info;
613 struct scatterlist;
614 
615 struct se_lun_acl {
616 	char			initiatorname[TRANSPORT_IQN_LEN];
617 	u32			mapped_lun;
618 	struct se_node_acl	*se_lun_nacl;
619 	struct se_lun		*se_lun;
620 	struct list_head	lacl_list;
621 	struct config_group	se_lun_group;
622 }  ____cacheline_aligned;
623 
624 struct se_dev_entry {
625 	int			def_pr_registered:1;
626 	/* See transport_lunflags_table */
627 	u32			lun_flags;
628 	u32			deve_cmds;
629 	u32			mapped_lun;
630 	u32			average_bytes;
631 	u32			last_byte_count;
632 	u32			total_cmds;
633 	u32			total_bytes;
634 	u64			pr_res_key;
635 	u64			creation_time;
636 	u32			attach_count;
637 	u64			read_bytes;
638 	u64			write_bytes;
639 	atomic_t		ua_count;
640 	/* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
641 	atomic_t		pr_ref_count;
642 	struct se_lun_acl	*se_lun_acl;
643 	spinlock_t		ua_lock;
644 	struct se_lun		*se_lun;
645 	struct list_head	alua_port_list;
646 	struct list_head	ua_list;
647 }  ____cacheline_aligned;
648 
649 struct se_dev_limits {
650 	/* Max supported HW queue depth */
651 	u32		hw_queue_depth;
652 	/* Max supported virtual queue depth */
653 	u32		queue_depth;
654 	/* From include/linux/blkdev.h for the other HW/SW limits. */
655 	struct queue_limits limits;
656 } ____cacheline_aligned;
657 
658 struct se_dev_attrib {
659 	int		emulate_dpo;
660 	int		emulate_fua_write;
661 	int		emulate_fua_read;
662 	int		emulate_write_cache;
663 	int		emulate_ua_intlck_ctrl;
664 	int		emulate_tas;
665 	int		emulate_tpu;
666 	int		emulate_tpws;
667 	int		emulate_reservations;
668 	int		emulate_alua;
669 	int		enforce_pr_isids;
670 	u32		hw_block_size;
671 	u32		block_size;
672 	u32		hw_max_sectors;
673 	u32		max_sectors;
674 	u32		optimal_sectors;
675 	u32		hw_queue_depth;
676 	u32		queue_depth;
677 	u32		task_timeout;
678 	u32		max_unmap_lba_count;
679 	u32		max_unmap_block_desc_count;
680 	u32		unmap_granularity;
681 	u32		unmap_granularity_alignment;
682 	struct se_subsystem_dev *da_sub_dev;
683 	struct config_group da_group;
684 } ____cacheline_aligned;
685 
686 struct se_subsystem_dev {
687 /* Used for struct se_subsystem_dev-->se_dev_alias, must be less than PAGE_SIZE */
688 #define SE_DEV_ALIAS_LEN		512
689 	unsigned char	se_dev_alias[SE_DEV_ALIAS_LEN];
690 /* Used for struct se_subsystem_dev->se_dev_udev_path[], must be less than PAGE_SIZE */
691 #define SE_UDEV_PATH_LEN		512
692 	unsigned char	se_dev_udev_path[SE_UDEV_PATH_LEN];
693 	u32		su_dev_flags;
694 	struct se_hba *se_dev_hba;
695 	struct se_device *se_dev_ptr;
696 	struct se_dev_attrib se_dev_attrib;
697 	/* T10 Asymmetric Logical Unit Assignment for Target Ports */
698 	struct t10_alua	t10_alua;
699 	/* T10 Inquiry and VPD WWN Information */
700 	struct t10_wwn	t10_wwn;
701 	/* T10 SPC-2 + SPC-3 Reservations */
702 	struct t10_reservation_template t10_reservation;
703 	spinlock_t      se_dev_lock;
704 	void            *se_dev_su_ptr;
705 	struct list_head g_se_dev_list;
706 	struct config_group se_dev_group;
707 	/* For T10 Reservations */
708 	struct config_group se_dev_pr_group;
709 } ____cacheline_aligned;
710 
711 #define T10_ALUA(su_dev)	(&(su_dev)->t10_alua)
712 #define T10_RES(su_dev)		(&(su_dev)->t10_reservation)
713 #define T10_PR_OPS(su_dev)	(&(su_dev)->t10_reservation.pr_ops)
714 
715 struct se_device {
716 	/* Set to 1 if thread is NOT sleeping on thread_sem */
717 	u8			thread_active;
718 	u8			dev_status_timer_flags;
719 	/* RELATIVE TARGET PORT IDENTIFER Counter */
720 	u16			dev_rpti_counter;
721 	/* Used for SAM Task Attribute ordering */
722 	u32			dev_cur_ordered_id;
723 	u32			dev_flags;
724 	u32			dev_port_count;
725 	/* See transport_device_status_table */
726 	u32			dev_status;
727 	u32			dev_tcq_window_closed;
728 	/* Physical device queue depth */
729 	u32			queue_depth;
730 	/* Used for SPC-2 reservations enforce of ISIDs */
731 	u64			dev_res_bin_isid;
732 	t10_task_attr_index_t	dev_task_attr_type;
733 	/* Pointer to transport specific device structure */
734 	void 			*dev_ptr;
735 	u32			dev_index;
736 	u64			creation_time;
737 	u32			num_resets;
738 	u64			num_cmds;
739 	u64			read_bytes;
740 	u64			write_bytes;
741 	spinlock_t		stats_lock;
742 	/* Active commands on this virtual SE device */
743 	atomic_t		active_cmds;
744 	atomic_t		simple_cmds;
745 	atomic_t		depth_left;
746 	atomic_t		dev_ordered_id;
747 	atomic_t		dev_tur_active;
748 	atomic_t		execute_tasks;
749 	atomic_t		dev_status_thr_count;
750 	atomic_t		dev_hoq_count;
751 	atomic_t		dev_ordered_sync;
752 	struct se_obj		dev_obj;
753 	struct se_obj		dev_access_obj;
754 	struct se_obj		dev_export_obj;
755 	struct se_queue_obj	*dev_queue_obj;
756 	struct se_queue_obj	*dev_status_queue_obj;
757 	spinlock_t		delayed_cmd_lock;
758 	spinlock_t		ordered_cmd_lock;
759 	spinlock_t		execute_task_lock;
760 	spinlock_t		state_task_lock;
761 	spinlock_t		dev_alua_lock;
762 	spinlock_t		dev_reservation_lock;
763 	spinlock_t		dev_state_lock;
764 	spinlock_t		dev_status_lock;
765 	spinlock_t		dev_status_thr_lock;
766 	spinlock_t		se_port_lock;
767 	spinlock_t		se_tmr_lock;
768 	/* Used for legacy SPC-2 reservationsa */
769 	struct se_node_acl	*dev_reserved_node_acl;
770 	/* Used for ALUA Logical Unit Group membership */
771 	struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
772 	/* Used for SPC-3 Persistent Reservations */
773 	struct t10_pr_registration *dev_pr_res_holder;
774 	struct list_head	dev_sep_list;
775 	struct list_head	dev_tmr_list;
776 	struct timer_list	dev_status_timer;
777 	/* Pointer to descriptor for processing thread */
778 	struct task_struct	*process_thread;
779 	pid_t			process_thread_pid;
780 	struct task_struct		*dev_mgmt_thread;
781 	struct list_head	delayed_cmd_list;
782 	struct list_head	ordered_cmd_list;
783 	struct list_head	execute_task_list;
784 	struct list_head	state_task_list;
785 	/* Pointer to associated SE HBA */
786 	struct se_hba		*se_hba;
787 	struct se_subsystem_dev *se_sub_dev;
788 	/* Pointer to template of function pointers for transport */
789 	struct se_subsystem_api *transport;
790 	/* Linked list for struct se_hba struct se_device list */
791 	struct list_head	dev_list;
792 	/* Linked list for struct se_global->g_se_dev_list */
793 	struct list_head	g_se_dev_list;
794 }  ____cacheline_aligned;
795 
796 #define SE_DEV(cmd)		((struct se_device *)(cmd)->se_lun->lun_se_dev)
797 #define SU_DEV(dev)		((struct se_subsystem_dev *)(dev)->se_sub_dev)
798 #define DEV_ATTRIB(dev)		(&(dev)->se_sub_dev->se_dev_attrib)
799 #define DEV_T10_WWN(dev)	(&(dev)->se_sub_dev->t10_wwn)
800 
801 struct se_hba {
802 	u16			hba_tpgt;
803 	u32			hba_id;
804 	/* See hba_flags_table */
805 	u32			hba_flags;
806 	/* Virtual iSCSI devices attached. */
807 	u32			dev_count;
808 	u32			hba_index;
809 	atomic_t		dev_mib_access_count;
810 	atomic_t		load_balance_queue;
811 	atomic_t		left_queue_depth;
812 	/* Maximum queue depth the HBA can handle. */
813 	atomic_t		max_queue_depth;
814 	/* Pointer to transport specific host structure. */
815 	void			*hba_ptr;
816 	/* Linked list for struct se_device */
817 	struct list_head	hba_dev_list;
818 	struct list_head	hba_list;
819 	spinlock_t		device_lock;
820 	spinlock_t		hba_queue_lock;
821 	struct config_group	hba_group;
822 	struct mutex		hba_access_mutex;
823 	struct se_subsystem_api *transport;
824 }  ____cacheline_aligned;
825 
826 #define SE_HBA(d)		((struct se_hba *)(d)->se_hba)
827 
828 struct se_lun {
829 	/* See transport_lun_status_table */
830 	enum transport_lun_status_table lun_status;
831 	u32			lun_access;
832 	u32			lun_flags;
833 	u32			unpacked_lun;
834 	atomic_t		lun_acl_count;
835 	spinlock_t		lun_acl_lock;
836 	spinlock_t		lun_cmd_lock;
837 	spinlock_t		lun_sep_lock;
838 	struct completion	lun_shutdown_comp;
839 	struct list_head	lun_cmd_list;
840 	struct list_head	lun_acl_list;
841 	struct se_device	*lun_se_dev;
842 	struct config_group	lun_group;
843 	struct se_port	*lun_sep;
844 } ____cacheline_aligned;
845 
846 #define SE_LUN(c)		((struct se_lun *)(c)->se_lun)
847 
848 struct se_port {
849 	/* RELATIVE TARGET PORT IDENTIFER */
850 	u16		sep_rtpi;
851 	int		sep_tg_pt_secondary_stat;
852 	int		sep_tg_pt_secondary_write_md;
853 	u32		sep_index;
854 	struct scsi_port_stats sep_stats;
855 	/* Used for ALUA Target Port Groups membership */
856 	atomic_t	sep_tg_pt_gp_active;
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 } ____cacheline_aligned;
868 
869 struct se_tpg_np {
870 	struct config_group	tpg_np_group;
871 } ____cacheline_aligned;
872 
873 struct se_portal_group {
874 	/* Type of target portal group, see transport_tpg_type_table */
875 	enum transport_tpg_type_table se_tpg_type;
876 	/* Number of ACLed Initiator Nodes for this TPG */
877 	u32			num_node_acls;
878 	/* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
879 	atomic_t		tpg_pr_ref_count;
880 	/* Spinlock for adding/removing ACLed Nodes */
881 	spinlock_t		acl_node_lock;
882 	/* Spinlock for adding/removing sessions */
883 	spinlock_t		session_lock;
884 	spinlock_t		tpg_lun_lock;
885 	/* Pointer to $FABRIC_MOD portal group */
886 	void			*se_tpg_fabric_ptr;
887 	struct list_head	se_tpg_list;
888 	/* linked list for initiator ACL list */
889 	struct list_head	acl_node_list;
890 	struct se_lun		*tpg_lun_list;
891 	struct se_lun		tpg_virt_lun0;
892 	/* List of TCM sessions assoicated wth this TPG */
893 	struct list_head	tpg_sess_list;
894 	/* Pointer to $FABRIC_MOD dependent code */
895 	struct target_core_fabric_ops *se_tpg_tfo;
896 	struct se_wwn		*se_tpg_wwn;
897 	struct config_group	tpg_group;
898 	struct config_group	*tpg_default_groups[6];
899 	struct config_group	tpg_lun_group;
900 	struct config_group	tpg_np_group;
901 	struct config_group	tpg_acl_group;
902 	struct config_group	tpg_attrib_group;
903 	struct config_group	tpg_param_group;
904 } ____cacheline_aligned;
905 
906 #define TPG_TFO(se_tpg)	((struct target_core_fabric_ops *)(se_tpg)->se_tpg_tfo)
907 
908 struct se_wwn {
909 	struct target_fabric_configfs *wwn_tf;
910 	struct config_group	wwn_group;
911 } ____cacheline_aligned;
912 
913 struct se_global {
914 	u16			alua_lu_gps_counter;
915 	int			g_sub_api_initialized;
916 	u32			in_shutdown;
917 	u32			alua_lu_gps_count;
918 	u32			g_hba_id_counter;
919 	struct config_group	target_core_hbagroup;
920 	struct config_group	alua_group;
921 	struct config_group	alua_lu_gps_group;
922 	struct list_head	g_lu_gps_list;
923 	struct list_head	g_se_tpg_list;
924 	struct list_head	g_hba_list;
925 	struct list_head	g_se_dev_list;
926 	struct se_hba		*g_lun0_hba;
927 	struct se_subsystem_dev *g_lun0_su_dev;
928 	struct se_device	*g_lun0_dev;
929 	struct t10_alua_lu_gp	*default_lu_gp;
930 	spinlock_t		g_device_lock;
931 	spinlock_t		hba_lock;
932 	spinlock_t		se_tpg_lock;
933 	spinlock_t		lu_gps_lock;
934 	spinlock_t		plugin_class_lock;
935 } ____cacheline_aligned;
936 
937 #endif /* TARGET_CORE_BASE_H */
938