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