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