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