]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/target/target_core_base.h
target: simplify command to task linkage
[mirror_ubuntu-focal-kernel.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
ef804a84 143/* struct se_task->task_flags */
6c76bf95
CH
144enum se_task_flags {
145 TF_ACTIVE = (1 << 0),
146 TF_SENT = (1 << 1),
2e982ab9 147 TF_REQUEST_STOP = (1 << 2),
ef804a84 148 TF_HAS_SENSE = (1 << 3),
c66ac9db
NB
149};
150
151/* Special transport agnostic struct se_cmd->t_states */
152enum transport_state_table {
153 TRANSPORT_NO_STATE = 0,
154 TRANSPORT_NEW_CMD = 1,
c66ac9db
NB
155 TRANSPORT_WRITE_PENDING = 3,
156 TRANSPORT_PROCESS_WRITE = 4,
157 TRANSPORT_PROCESSING = 5,
35e0e757 158 TRANSPORT_COMPLETE = 6,
c66ac9db 159 TRANSPORT_PROCESS_TMR = 9,
c66ac9db 160 TRANSPORT_ISTATE_PROCESSING = 11,
c66ac9db 161 TRANSPORT_NEW_CMD_MAP = 16,
07bde79a 162 TRANSPORT_COMPLETE_QF_WP = 18,
e057f533 163 TRANSPORT_COMPLETE_QF_OK = 19,
c66ac9db
NB
164};
165
166/* Used for struct se_cmd->se_cmd_flags */
167enum se_cmd_flags_table {
168 SCF_SUPPORTED_SAM_OPCODE = 0x00000001,
169 SCF_TRANSPORT_TASK_SENSE = 0x00000002,
170 SCF_EMULATED_TASK_SENSE = 0x00000004,
171 SCF_SCSI_DATA_SG_IO_CDB = 0x00000008,
172 SCF_SCSI_CONTROL_SG_IO_CDB = 0x00000010,
c8e31f26
AG
173 SCF_SCSI_NON_DATA_CDB = 0x00000020,
174 SCF_SCSI_TMR_CDB = 0x00000040,
c66ac9db
NB
175 SCF_SCSI_CDB_EXCEPTION = 0x00000080,
176 SCF_SCSI_RESERVATION_CONFLICT = 0x00000100,
2d3a4b51 177 SCF_FUA = 0x00000200,
c66ac9db
NB
178 SCF_SE_LUN_CMD = 0x00000800,
179 SCF_SE_ALLOW_EOO = 0x00001000,
33c3fafc 180 SCF_BIDI = 0x00002000,
c66ac9db
NB
181 SCF_SENT_CHECK_CONDITION = 0x00004000,
182 SCF_OVERFLOW_BIT = 0x00008000,
183 SCF_UNDERFLOW_BIT = 0x00010000,
184 SCF_SENT_DELAYED_TAS = 0x00020000,
185 SCF_ALUA_NON_OPTIMIZED = 0x00040000,
186 SCF_DELAYED_CMD_FROM_SAM_ATTR = 0x00080000,
5951146d 187 SCF_UNUSED = 0x00100000,
86715569
NB
188 SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00200000,
189 SCF_ACK_KREF = 0x00400000,
c66ac9db
NB
190};
191
192/* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
193enum transport_lunflags_table {
194 TRANSPORT_LUNFLAGS_NO_ACCESS = 0x00,
195 TRANSPORT_LUNFLAGS_INITIATOR_ACCESS = 0x01,
196 TRANSPORT_LUNFLAGS_READ_ONLY = 0x02,
197 TRANSPORT_LUNFLAGS_READ_WRITE = 0x04,
198};
199
200/* struct se_device->dev_status */
201enum transport_device_status_table {
202 TRANSPORT_DEVICE_ACTIVATED = 0x01,
203 TRANSPORT_DEVICE_DEACTIVATED = 0x02,
204 TRANSPORT_DEVICE_QUEUE_FULL = 0x04,
205 TRANSPORT_DEVICE_SHUTDOWN = 0x08,
206 TRANSPORT_DEVICE_OFFLINE_ACTIVATED = 0x10,
207 TRANSPORT_DEVICE_OFFLINE_DEACTIVATED = 0x20,
208};
209
210/*
211 * Used by transport_send_check_condition_and_sense() and se_cmd->scsi_sense_reason
212 * to signal which ASC/ASCQ sense payload should be built.
213 */
214enum tcm_sense_reason_table {
215 TCM_NON_EXISTENT_LUN = 0x01,
216 TCM_UNSUPPORTED_SCSI_OPCODE = 0x02,
217 TCM_INCORRECT_AMOUNT_OF_DATA = 0x03,
218 TCM_UNEXPECTED_UNSOLICITED_DATA = 0x04,
219 TCM_SERVICE_CRC_ERROR = 0x05,
220 TCM_SNACK_REJECTED = 0x06,
221 TCM_SECTOR_COUNT_TOO_MANY = 0x07,
222 TCM_INVALID_CDB_FIELD = 0x08,
223 TCM_INVALID_PARAMETER_LIST = 0x09,
224 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = 0x0a,
225 TCM_UNKNOWN_MODE_PAGE = 0x0b,
226 TCM_WRITE_PROTECTED = 0x0c,
227 TCM_CHECK_CONDITION_ABORT_CMD = 0x0d,
228 TCM_CHECK_CONDITION_UNIT_ATTENTION = 0x0e,
229 TCM_CHECK_CONDITION_NOT_READY = 0x0f,
03e98c9e 230 TCM_RESERVATION_CONFLICT = 0x10,
c66ac9db
NB
231};
232
a6360785
NB
233enum target_sc_flags_table {
234 TARGET_SCF_BIDI_OP = 0x01,
235 TARGET_SCF_ACK_KREF = 0x02,
b0d79946 236 TARGET_SCF_UNKNOWN_SIZE = 0x04,
a6360785
NB
237};
238
c4795fb2
CH
239/* fabric independent task management function values */
240enum tcm_tmreq_table {
241 TMR_ABORT_TASK = 1,
242 TMR_ABORT_TASK_SET = 2,
243 TMR_CLEAR_ACA = 3,
244 TMR_CLEAR_TASK_SET = 4,
245 TMR_LUN_RESET = 5,
246 TMR_TARGET_WARM_RESET = 6,
247 TMR_TARGET_COLD_RESET = 7,
248 TMR_FABRIC_TMR = 255,
249};
250
251/* fabric independent task management response values */
252enum tcm_tmrsp_table {
253 TMR_FUNCTION_COMPLETE = 0,
254 TMR_TASK_DOES_NOT_EXIST = 1,
255 TMR_LUN_DOES_NOT_EXIST = 2,
256 TMR_TASK_STILL_ALLEGIANT = 3,
257 TMR_TASK_FAILOVER_NOT_SUPPORTED = 4,
258 TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED = 5,
259 TMR_FUNCTION_AUTHORIZATION_FAILED = 6,
260 TMR_FUNCTION_REJECTED = 255,
261};
262
c66ac9db
NB
263struct se_obj {
264 atomic_t obj_access_count;
e0a53e70 265};
c66ac9db
NB
266
267/*
268 * Used by TCM Core internally to signal if ALUA emulation is enabled or
269 * disabled, or running in with TCM/pSCSI passthrough mode
270 */
271typedef enum {
272 SPC_ALUA_PASSTHROUGH,
273 SPC2_ALUA_DISABLED,
274 SPC3_ALUA_EMULATED
275} t10_alua_index_t;
276
277/*
278 * Used by TCM Core internally to signal if SAM Task Attribute emulation
279 * is enabled or disabled, or running in with TCM/pSCSI passthrough mode
280 */
281typedef enum {
282 SAM_TASK_ATTR_PASSTHROUGH,
283 SAM_TASK_ATTR_UNTAGGED,
284 SAM_TASK_ATTR_EMULATED
285} t10_task_attr_index_t;
286
e89d15ee
NB
287/*
288 * Used for target SCSI statistics
289 */
290typedef enum {
291 SCSI_INST_INDEX,
292 SCSI_DEVICE_INDEX,
293 SCSI_AUTH_INTR_INDEX,
294 SCSI_INDEX_TYPE_MAX
295} scsi_index_t;
296
c66ac9db
NB
297struct se_cmd;
298
299struct t10_alua {
300 t10_alua_index_t alua_type;
301 /* ALUA Target Port Group ID */
302 u16 alua_tg_pt_gps_counter;
303 u32 alua_tg_pt_gps_count;
304 spinlock_t tg_pt_gps_lock;
305 struct se_subsystem_dev *t10_sub_dev;
306 /* Used for default ALUA Target Port Group */
307 struct t10_alua_tg_pt_gp *default_tg_pt_gp;
308 /* Used for default ALUA Target Port Group ConfigFS group */
309 struct config_group alua_tg_pt_gps_group;
310 int (*alua_state_check)(struct se_cmd *, unsigned char *, u8 *);
311 struct list_head tg_pt_gps_list;
e0a53e70 312};
c66ac9db
NB
313
314struct t10_alua_lu_gp {
315 u16 lu_gp_id;
316 int lu_gp_valid_id;
317 u32 lu_gp_members;
c66ac9db
NB
318 atomic_t lu_gp_ref_cnt;
319 spinlock_t lu_gp_lock;
320 struct config_group lu_gp_group;
e3d6f909 321 struct list_head lu_gp_node;
c66ac9db 322 struct list_head lu_gp_mem_list;
e0a53e70 323};
c66ac9db
NB
324
325struct t10_alua_lu_gp_member {
5dd7ed2e 326 bool lu_gp_assoc;
c66ac9db
NB
327 atomic_t lu_gp_mem_ref_cnt;
328 spinlock_t lu_gp_mem_lock;
329 struct t10_alua_lu_gp *lu_gp;
330 struct se_device *lu_gp_mem_dev;
331 struct list_head lu_gp_mem_list;
e0a53e70 332};
c66ac9db
NB
333
334struct t10_alua_tg_pt_gp {
335 u16 tg_pt_gp_id;
336 int tg_pt_gp_valid_id;
337 int tg_pt_gp_alua_access_status;
338 int tg_pt_gp_alua_access_type;
339 int tg_pt_gp_nonop_delay_msecs;
340 int tg_pt_gp_trans_delay_msecs;
341 int tg_pt_gp_pref;
342 int tg_pt_gp_write_metadata;
343 /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
344#define ALUA_MD_BUF_LEN 1024
345 u32 tg_pt_gp_md_buf_len;
346 u32 tg_pt_gp_members;
347 atomic_t tg_pt_gp_alua_access_state;
348 atomic_t tg_pt_gp_ref_cnt;
349 spinlock_t tg_pt_gp_lock;
350 struct mutex tg_pt_gp_md_mutex;
351 struct se_subsystem_dev *tg_pt_gp_su_dev;
352 struct config_group tg_pt_gp_group;
353 struct list_head tg_pt_gp_list;
354 struct list_head tg_pt_gp_mem_list;
e0a53e70 355};
c66ac9db
NB
356
357struct t10_alua_tg_pt_gp_member {
5dd7ed2e 358 bool tg_pt_gp_assoc;
c66ac9db
NB
359 atomic_t tg_pt_gp_mem_ref_cnt;
360 spinlock_t tg_pt_gp_mem_lock;
361 struct t10_alua_tg_pt_gp *tg_pt_gp;
362 struct se_port *tg_pt;
363 struct list_head tg_pt_gp_mem_list;
e0a53e70 364};
c66ac9db
NB
365
366struct t10_vpd {
367 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
368 int protocol_identifier_set;
369 u32 protocol_identifier;
370 u32 device_identifier_code_set;
371 u32 association;
372 u32 device_identifier_type;
373 struct list_head vpd_list;
e0a53e70 374};
c66ac9db
NB
375
376struct t10_wwn {
e3d6f909
AG
377 char vendor[8];
378 char model[16];
379 char revision[4];
380 char unit_serial[INQUIRY_VPD_SERIAL_LEN];
c66ac9db
NB
381 spinlock_t t10_vpd_lock;
382 struct se_subsystem_dev *t10_sub_dev;
383 struct config_group t10_wwn_group;
384 struct list_head t10_vpd_list;
e0a53e70 385};
c66ac9db
NB
386
387
388/*
25985edc 389 * Used by TCM Core internally to signal if >= SPC-3 persistent reservations
c66ac9db
NB
390 * emulation is enabled or disabled, or running in with TCM/pSCSI passthrough
391 * mode
392 */
393typedef enum {
394 SPC_PASSTHROUGH,
395 SPC2_RESERVATIONS,
396 SPC3_PERSISTENT_RESERVATIONS
397} t10_reservations_index_t;
398
399struct t10_pr_registration {
400 /* Used for fabrics that contain WWN+ISID */
401#define PR_REG_ISID_LEN 16
402 /* PR_REG_ISID_LEN + ',i,0x' */
403#define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
404 char pr_reg_isid[PR_REG_ISID_LEN];
405 /* Used during APTPL metadata reading */
406#define PR_APTPL_MAX_IPORT_LEN 256
407 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
408 /* Used during APTPL metadata reading */
409#define PR_APTPL_MAX_TPORT_LEN 256
410 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
411 /* For writing out live meta data */
412 unsigned char *pr_aptpl_buf;
413 u16 pr_aptpl_rpti;
414 u16 pr_reg_tpgt;
415 /* Reservation effects all target ports */
416 int pr_reg_all_tg_pt;
417 /* Activate Persistence across Target Power Loss */
418 int pr_reg_aptpl;
419 int pr_res_holder;
420 int pr_res_type;
421 int pr_res_scope;
422 /* Used for fabric initiator WWPNs using a ISID */
5dd7ed2e 423 bool isid_present_at_reg;
c66ac9db
NB
424 u32 pr_res_mapped_lun;
425 u32 pr_aptpl_target_lun;
426 u32 pr_res_generation;
427 u64 pr_reg_bin_isid;
428 u64 pr_res_key;
429 atomic_t pr_res_holders;
430 struct se_node_acl *pr_reg_nacl;
431 struct se_dev_entry *pr_reg_deve;
432 struct se_lun *pr_reg_tg_pt_lun;
433 struct list_head pr_reg_list;
434 struct list_head pr_reg_abort_list;
435 struct list_head pr_reg_aptpl_list;
436 struct list_head pr_reg_atp_list;
437 struct list_head pr_reg_atp_mem_list;
e0a53e70 438};
c66ac9db
NB
439
440/*
441 * This set of function pointer ops is set based upon SPC3_PERSISTENT_RESERVATIONS,
442 * SPC2_RESERVATIONS or SPC_PASSTHROUGH in drivers/target/target_core_pr.c:
443 * core_setup_reservations()
444 */
445struct t10_reservation_ops {
446 int (*t10_reservation_check)(struct se_cmd *, u32 *);
447 int (*t10_seq_non_holder)(struct se_cmd *, unsigned char *, u32);
448 int (*t10_pr_register)(struct se_cmd *);
449 int (*t10_pr_clear)(struct se_cmd *);
450};
451
e3d6f909 452struct t10_reservation {
c66ac9db
NB
453 /* Reservation effects all target ports */
454 int pr_all_tg_pt;
455 /* Activate Persistence across Target Power Loss enabled
456 * for SCSI device */
457 int pr_aptpl_active;
e3d6f909 458 /* Used by struct t10_reservation->pr_aptpl_buf_len */
c66ac9db
NB
459#define PR_APTPL_BUF_LEN 8192
460 u32 pr_aptpl_buf_len;
461 u32 pr_generation;
462 t10_reservations_index_t res_type;
463 spinlock_t registration_lock;
464 spinlock_t aptpl_reg_lock;
465 /*
466 * This will always be set by one individual I_T Nexus.
467 * However with all_tg_pt=1, other I_T Nexus from the
468 * same initiator can access PR reg/res info on a different
469 * target port.
470 *
471 * There is also the 'All Registrants' case, where there is
472 * a single *pr_res_holder of the reservation, but all
473 * registrations are considered reservation holders.
474 */
475 struct se_node_acl *pr_res_holder;
476 struct list_head registration_list;
477 struct list_head aptpl_reg_list;
478 struct t10_reservation_ops pr_ops;
e0a53e70 479};
c66ac9db 480
c66ac9db
NB
481struct se_queue_obj {
482 atomic_t queue_cnt;
483 spinlock_t cmd_queue_lock;
484 struct list_head qobj_list;
485 wait_queue_head_t thread_wq;
e0a53e70 486};
c66ac9db 487
c66ac9db 488struct se_task {
3189b067
CH
489 struct se_cmd *task_se_cmd;
490 struct scatterlist *task_sg;
3189b067
CH
491 u32 task_sg_nents;
492 u16 task_flags;
3189b067 493 u8 task_scsi_status;
c66ac9db 494 enum dma_data_direction task_data_direction;
3189b067
CH
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
c8e31f26
AG
501struct se_tmr_req {
502 /* Task Management function to be performed */
503 u8 function;
504 /* Task Management response to send */
505 u8 response;
506 int call_transport;
507 /* Reference to ITT that Task Mgmt should be performed */
508 u32 ref_task_tag;
509 /* 64-bit encoded SAM LUN from $FABRIC_MOD TMR header */
510 u64 ref_task_lun;
511 void *fabric_tmr_ptr;
512 struct se_cmd *task_cmd;
513 struct se_cmd *ref_cmd;
514 struct se_device *tmr_dev;
515 struct se_lun *tmr_lun;
516 struct list_head tmr_list;
517};
518
c66ac9db
NB
519struct se_cmd {
520 /* SAM response code being sent to initiator */
521 u8 scsi_status;
522 u8 scsi_asc;
523 u8 scsi_ascq;
524 u8 scsi_sense_reason;
525 u16 scsi_sense_length;
526 /* Delay for ALUA Active/NonOptimized state access in milliseconds */
527 int alua_nonop_delay;
528 /* See include/linux/dma-mapping.h */
529 enum dma_data_direction data_direction;
530 /* For SAM Task Attribute */
531 int sam_task_attr;
532 /* Transport protocol dependent state, see transport_state_table */
533 enum transport_state_table t_state;
a17f091d 534 /* Used to signal cmd->se_tfo->check_release_cmd() usage per cmd */
5f655e8d
BVA
535 unsigned check_release:1;
536 unsigned cmd_wait_set:1;
b0d79946 537 unsigned unknown_data_length:1;
c66ac9db
NB
538 /* See se_cmd_flags_table */
539 u32 se_cmd_flags;
540 u32 se_ordered_id;
541 /* Total size in bytes associated with command */
542 u32 data_length;
543 /* SCSI Presented Data Transfer Length */
544 u32 cmd_spdtl;
545 u32 residual_count;
546 u32 orig_fe_lun;
547 /* Persistent Reservation key */
548 u64 pr_res_key;
c66ac9db
NB
549 /* Used for sense data */
550 void *sense_buffer;
5951146d 551 struct list_head se_delayed_node;
5951146d 552 struct list_head se_lun_node;
07bde79a 553 struct list_head se_qf_node;
c66ac9db
NB
554 struct se_device *se_dev;
555 struct se_dev_entry *se_deve;
c66ac9db
NB
556 struct se_lun *se_lun;
557 /* Only used for internal passthrough and legacy TCM fabric modules */
558 struct se_session *se_sess;
559 struct se_tmr_req *se_tmr_req;
5951146d 560 struct list_head se_queue_node;
a17f091d
NB
561 struct list_head se_cmd_list;
562 struct completion cmd_wait_comp;
7481deb4 563 struct kref cmd_kref;
c66ac9db 564 struct target_core_fabric_ops *se_tfo;
6bb35e00 565 int (*execute_cmd)(struct se_cmd *);
c66ac9db 566 void (*transport_complete_callback)(struct se_cmd *);
07bde79a 567
a1d8b49a
AG
568 unsigned char *t_task_cdb;
569 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
570 unsigned long long t_task_lba;
a1d8b49a
AG
571 atomic_t t_fe_count;
572 atomic_t t_se_count;
573 atomic_t t_task_cdbs_left;
574 atomic_t t_task_cdbs_ex_left;
7d680f3b
CH
575 unsigned int transport_state;
576#define CMD_T_ABORTED (1 << 0)
577#define CMD_T_ACTIVE (1 << 1)
578#define CMD_T_COMPLETE (1 << 2)
579#define CMD_T_QUEUED (1 << 3)
580#define CMD_T_SENT (1 << 4)
581#define CMD_T_STOP (1 << 5)
582#define CMD_T_FAILED (1 << 6)
583#define CMD_T_LUN_STOP (1 << 7)
584#define CMD_T_LUN_FE_STOP (1 << 8)
585#define CMD_T_DEV_ACTIVE (1 << 9)
a1d8b49a
AG
586 spinlock_t t_state_lock;
587 struct completion t_transport_stop_comp;
588 struct completion transport_lun_fe_stop_comp;
589 struct completion transport_lun_stop_comp;
05d1c7c0 590
35e0e757
CH
591 struct work_struct work;
592
ec98f782
AG
593 struct scatterlist *t_data_sg;
594 unsigned int t_data_nents;
4949314c 595 void *t_data_vmap;
ec98f782
AG
596 struct scatterlist *t_bidi_data_sg;
597 unsigned int t_bidi_data_nents;
598
785fdf70 599 struct se_task *t_task;
e0a53e70 600};
c66ac9db 601
c66ac9db
NB
602struct se_ua {
603 u8 ua_asc;
604 u8 ua_ascq;
605 struct se_node_acl *ua_nacl;
606 struct list_head ua_dev_list;
607 struct list_head ua_nacl_list;
e0a53e70 608};
c66ac9db
NB
609
610struct se_node_acl {
611 char initiatorname[TRANSPORT_IQN_LEN];
612 /* Used to signal demo mode created ACL, disabled by default */
5dd7ed2e 613 bool dynamic_node_acl;
337c0607 614 bool acl_stop:1;
c66ac9db
NB
615 u32 queue_depth;
616 u32 acl_index;
617 u64 num_cmds;
618 u64 read_bytes;
619 u64 write_bytes;
620 spinlock_t stats_lock;
621 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
622 atomic_t acl_pr_ref_count;
f2083241 623 struct se_dev_entry **device_list;
c66ac9db
NB
624 struct se_session *nacl_sess;
625 struct se_portal_group *se_tpg;
626 spinlock_t device_list_lock;
627 spinlock_t nacl_sess_lock;
628 struct config_group acl_group;
629 struct config_group acl_attrib_group;
630 struct config_group acl_auth_group;
631 struct config_group acl_param_group;
12d23384
NB
632 struct config_group acl_fabric_stat_group;
633 struct config_group *acl_default_groups[5];
c66ac9db
NB
634 struct list_head acl_list;
635 struct list_head acl_sess_list;
01468346 636 struct completion acl_free_comp;
afb999ff 637 struct kref acl_kref;
e0a53e70 638};
c66ac9db
NB
639
640struct se_session {
5f655e8d 641 unsigned sess_tearing_down:1;
c66ac9db
NB
642 u64 sess_bin_isid;
643 struct se_node_acl *se_node_acl;
644 struct se_portal_group *se_tpg;
645 void *fabric_sess_ptr;
646 struct list_head sess_list;
647 struct list_head sess_acl_list;
a17f091d
NB
648 struct list_head sess_cmd_list;
649 struct list_head sess_wait_list;
650 spinlock_t sess_cmd_lock;
41ac82b6 651 struct kref sess_kref;
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;
015487b8 726 u32 fabric_max_sectors;
c66ac9db
NB
727 u32 optimal_sectors;
728 u32 hw_queue_depth;
729 u32 queue_depth;
c66ac9db
NB
730 u32 max_unmap_lba_count;
731 u32 max_unmap_block_desc_count;
732 u32 unmap_granularity;
733 u32 unmap_granularity_alignment;
734 struct se_subsystem_dev *da_sub_dev;
735 struct config_group da_group;
e0a53e70 736};
c66ac9db 737
12d23384
NB
738struct se_dev_stat_grps {
739 struct config_group stat_group;
740 struct config_group scsi_dev_group;
741 struct config_group scsi_tgt_dev_group;
742 struct config_group scsi_lu_group;
743};
744
c66ac9db
NB
745struct se_subsystem_dev {
746/* Used for struct se_subsystem_dev-->se_dev_alias, must be less than PAGE_SIZE */
747#define SE_DEV_ALIAS_LEN 512
748 unsigned char se_dev_alias[SE_DEV_ALIAS_LEN];
749/* Used for struct se_subsystem_dev->se_dev_udev_path[], must be less than PAGE_SIZE */
750#define SE_UDEV_PATH_LEN 512
751 unsigned char se_dev_udev_path[SE_UDEV_PATH_LEN];
752 u32 su_dev_flags;
753 struct se_hba *se_dev_hba;
754 struct se_device *se_dev_ptr;
755 struct se_dev_attrib se_dev_attrib;
756 /* T10 Asymmetric Logical Unit Assignment for Target Ports */
757 struct t10_alua t10_alua;
758 /* T10 Inquiry and VPD WWN Information */
759 struct t10_wwn t10_wwn;
760 /* T10 SPC-2 + SPC-3 Reservations */
e3d6f909 761 struct t10_reservation t10_pr;
c66ac9db
NB
762 spinlock_t se_dev_lock;
763 void *se_dev_su_ptr;
c66ac9db
NB
764 struct config_group se_dev_group;
765 /* For T10 Reservations */
766 struct config_group se_dev_pr_group;
12d23384
NB
767 /* For target_core_stat.c groups */
768 struct se_dev_stat_grps dev_stat_grps;
e0a53e70 769};
c66ac9db 770
c66ac9db 771struct se_device {
c66ac9db
NB
772 /* RELATIVE TARGET PORT IDENTIFER Counter */
773 u16 dev_rpti_counter;
774 /* Used for SAM Task Attribute ordering */
775 u32 dev_cur_ordered_id;
776 u32 dev_flags;
777 u32 dev_port_count;
778 /* See transport_device_status_table */
779 u32 dev_status;
c66ac9db
NB
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 795 atomic_t simple_cmds;
c66ac9db 796 atomic_t dev_ordered_id;
c66ac9db 797 atomic_t execute_tasks;
c66ac9db 798 atomic_t dev_ordered_sync;
07bde79a 799 atomic_t dev_qf_count;
c66ac9db
NB
800 struct se_obj dev_obj;
801 struct se_obj dev_access_obj;
802 struct se_obj dev_export_obj;
e3d6f909 803 struct se_queue_obj dev_queue_obj;
c66ac9db 804 spinlock_t delayed_cmd_lock;
c66ac9db 805 spinlock_t execute_task_lock;
c66ac9db 806 spinlock_t dev_reservation_lock;
c66ac9db 807 spinlock_t dev_status_lock;
c66ac9db
NB
808 spinlock_t se_port_lock;
809 spinlock_t se_tmr_lock;
07bde79a 810 spinlock_t qf_cmd_lock;
c66ac9db
NB
811 /* Used for legacy SPC-2 reservationsa */
812 struct se_node_acl *dev_reserved_node_acl;
813 /* Used for ALUA Logical Unit Group membership */
814 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
815 /* Used for SPC-3 Persistent Reservations */
816 struct t10_pr_registration *dev_pr_res_holder;
817 struct list_head dev_sep_list;
818 struct list_head dev_tmr_list;
c66ac9db
NB
819 /* Pointer to descriptor for processing thread */
820 struct task_struct *process_thread;
07bde79a 821 struct work_struct qf_work_queue;
c66ac9db 822 struct list_head delayed_cmd_list;
c66ac9db
NB
823 struct list_head execute_task_list;
824 struct list_head state_task_list;
07bde79a 825 struct list_head qf_cmd_list;
c66ac9db
NB
826 /* Pointer to associated SE HBA */
827 struct se_hba *se_hba;
828 struct se_subsystem_dev *se_sub_dev;
829 /* Pointer to template of function pointers for transport */
830 struct se_subsystem_api *transport;
831 /* Linked list for struct se_hba struct se_device list */
832 struct list_head dev_list;
e0a53e70 833};
c66ac9db 834
c66ac9db
NB
835struct se_hba {
836 u16 hba_tpgt;
837 u32 hba_id;
838 /* See hba_flags_table */
839 u32 hba_flags;
840 /* Virtual iSCSI devices attached. */
841 u32 dev_count;
842 u32 hba_index;
c66ac9db
NB
843 /* Pointer to transport specific host structure. */
844 void *hba_ptr;
845 /* Linked list for struct se_device */
846 struct list_head hba_dev_list;
e3d6f909 847 struct list_head hba_node;
c66ac9db 848 spinlock_t device_lock;
c66ac9db
NB
849 struct config_group hba_group;
850 struct mutex hba_access_mutex;
851 struct se_subsystem_api *transport;
e0a53e70 852};
c66ac9db 853
12d23384
NB
854struct se_port_stat_grps {
855 struct config_group stat_group;
856 struct config_group scsi_port_group;
857 struct config_group scsi_tgt_port_group;
858 struct config_group scsi_transport_group;
859};
860
c66ac9db
NB
861struct se_lun {
862 /* See transport_lun_status_table */
863 enum transport_lun_status_table lun_status;
864 u32 lun_access;
865 u32 lun_flags;
866 u32 unpacked_lun;
867 atomic_t lun_acl_count;
868 spinlock_t lun_acl_lock;
869 spinlock_t lun_cmd_lock;
870 spinlock_t lun_sep_lock;
871 struct completion lun_shutdown_comp;
872 struct list_head lun_cmd_list;
873 struct list_head lun_acl_list;
874 struct se_device *lun_se_dev;
12d23384 875 struct se_port *lun_sep;
c66ac9db 876 struct config_group lun_group;
12d23384 877 struct se_port_stat_grps port_stat_grps;
e0a53e70 878};
c66ac9db 879
e89d15ee
NB
880struct scsi_port_stats {
881 u64 cmd_pdus;
882 u64 tx_data_octets;
883 u64 rx_data_octets;
e0a53e70 884};
e89d15ee 885
c66ac9db
NB
886struct se_port {
887 /* RELATIVE TARGET PORT IDENTIFER */
888 u16 sep_rtpi;
889 int sep_tg_pt_secondary_stat;
890 int sep_tg_pt_secondary_write_md;
891 u32 sep_index;
892 struct scsi_port_stats sep_stats;
893 /* Used for ALUA Target Port Groups membership */
c66ac9db
NB
894 atomic_t sep_tg_pt_secondary_offline;
895 /* Used for PR ALL_TG_PT=1 */
896 atomic_t sep_tg_pt_ref_cnt;
897 spinlock_t sep_alua_lock;
898 struct mutex sep_tg_pt_md_mutex;
899 struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
900 struct se_lun *sep_lun;
901 struct se_portal_group *sep_tpg;
902 struct list_head sep_alua_list;
903 struct list_head sep_list;
e0a53e70 904};
c66ac9db
NB
905
906struct se_tpg_np {
1f6fe7cb 907 struct se_portal_group *tpg_np_parent;
c66ac9db 908 struct config_group tpg_np_group;
e0a53e70 909};
c66ac9db
NB
910
911struct se_portal_group {
912 /* Type of target portal group, see transport_tpg_type_table */
913 enum transport_tpg_type_table se_tpg_type;
914 /* Number of ACLed Initiator Nodes for this TPG */
915 u32 num_node_acls;
916 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
917 atomic_t tpg_pr_ref_count;
918 /* Spinlock for adding/removing ACLed Nodes */
919 spinlock_t acl_node_lock;
920 /* Spinlock for adding/removing sessions */
921 spinlock_t session_lock;
922 spinlock_t tpg_lun_lock;
923 /* Pointer to $FABRIC_MOD portal group */
924 void *se_tpg_fabric_ptr;
e3d6f909 925 struct list_head se_tpg_node;
c66ac9db
NB
926 /* linked list for initiator ACL list */
927 struct list_head acl_node_list;
4a5a75f3 928 struct se_lun **tpg_lun_list;
c66ac9db 929 struct se_lun tpg_virt_lun0;
25985edc 930 /* List of TCM sessions associated wth this TPG */
c66ac9db
NB
931 struct list_head tpg_sess_list;
932 /* Pointer to $FABRIC_MOD dependent code */
933 struct target_core_fabric_ops *se_tpg_tfo;
934 struct se_wwn *se_tpg_wwn;
935 struct config_group tpg_group;
936 struct config_group *tpg_default_groups[6];
937 struct config_group tpg_lun_group;
938 struct config_group tpg_np_group;
939 struct config_group tpg_acl_group;
940 struct config_group tpg_attrib_group;
941 struct config_group tpg_param_group;
e0a53e70 942};
c66ac9db 943
c66ac9db
NB
944struct se_wwn {
945 struct target_fabric_configfs *wwn_tf;
946 struct config_group wwn_group;
12d23384
NB
947 struct config_group *wwn_default_groups[2];
948 struct config_group fabric_stat_group;
e0a53e70 949};
c66ac9db 950
c66ac9db 951#endif /* TARGET_CORE_BASE_H */