]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/target/target_core_base.h
target: remove target_core_configfs.h
[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>
c0add7fd 8#include <linux/percpu_ida.h>
c66ac9db
NB
9#include <scsi/scsi_cmnd.h>
10#include <net/sock.h>
11#include <net/tcp.h>
c66ac9db 12
ce8dd25d 13#define TARGET_CORE_VERSION "v4.1.0"
c66ac9db 14
c66ac9db
NB
15/*
16 * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
17 *
18 * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
19 * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
20 * 16-byte CDBs by default and require an extra allocation for
25985edc 21 * 32-byte CDBs to because of legacy issues.
c66ac9db
NB
22 *
23 * Within TCM Core there are no such legacy limitiations, so we go ahead
24 * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
25 * within all TCM Core and subsystem plugin code.
26 */
27#define TCM_MAX_COMMAND_SIZE 32
28/*
29 * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
30 * defined 96, but the real limit is 252 (or 260 including the header)
31 */
32#define TRANSPORT_SENSE_BUFFER SCSI_SENSE_BUFFERSIZE
33/* Used by transport_send_check_condition_and_sense() */
34#define SPC_SENSE_KEY_OFFSET 2
895f3022 35#define SPC_ADD_SENSE_LEN_OFFSET 7
76736db3
SG
36#define SPC_DESC_TYPE_OFFSET 8
37#define SPC_ADDITIONAL_DESC_LEN_OFFSET 9
38#define SPC_VALIDITY_OFFSET 10
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 */
703d641d 47#define VPD_TMP_BUF_SIZE 254
c66ac9db
NB
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
c4795fb2
CH
65/* struct se_dev_attrib sanity values */
66/* Default max_unmap_lba_count */
67#define DA_MAX_UNMAP_LBA_COUNT 0
68/* Default max_unmap_block_desc_count */
69#define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0
70/* Default unmap_granularity */
71#define DA_UNMAP_GRANULARITY_DEFAULT 0
72/* Default unmap_granularity_alignment */
73#define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0
773cbaf7
NB
74/* Default max_write_same_len, disabled by default */
75#define DA_MAX_WRITE_SAME_LEN 0
adfa9570
TB
76/* Use a model alias based on the configfs backend device name */
77#define DA_EMULATE_MODEL_ALIAS 0
c4795fb2
CH
78/* Emulation for WriteCache and SYNCHRONIZE_CACHE */
79#define DA_EMULATE_WRITE_CACHE 0
80/* Emulation for UNIT ATTENTION Interlock Control */
81#define DA_EMULATE_UA_INTLLCK_CTRL 0
82/* Emulation for TASK_ABORTED status (TAS) by default */
83#define DA_EMULATE_TAS 1
84/* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
85#define DA_EMULATE_TPU 0
86/*
87 * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
88 * block/blk-lib.c:blkdev_issue_discard()
89 */
90#define DA_EMULATE_TPWS 0
0123a9ec
NB
91/* Emulation for CompareAndWrite (AtomicTestandSet) by default */
92#define DA_EMULATE_CAW 1
d397a445
NB
93/* Emulation for 3rd Party Copy (ExtendedCopy) by default */
94#define DA_EMULATE_3PC 1
c4795fb2 95/* No Emulation for PSCSI by default */
c4795fb2
CH
96#define DA_EMULATE_ALUA 0
97/* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
98#define DA_ENFORCE_PR_ISIDS 1
92404e60
NB
99/* Force SPC-3 PR Activate Persistence across Target Power Loss */
100#define DA_FORCE_PR_APTPL 0
c4795fb2
CH
101#define DA_STATUS_MAX_SECTORS_MIN 16
102#define DA_STATUS_MAX_SECTORS_MAX 8192
103/* By default don't report non-rotating (solid state) medium */
104#define DA_IS_NONROT 0
105/* Queue Algorithm Modifier default for restricted reordering in control mode page */
106#define DA_EMULATE_REST_REORD 0
107
f82f320e 108#define SE_INQUIRY_BUF 1024
c4795fb2 109#define SE_MODE_PAGE_BUF 512
32a8811f 110#define SE_SENSE_BUF 96
c4795fb2 111
c66ac9db
NB
112/* struct se_hba->hba_flags */
113enum hba_flags_table {
114 HBA_FLAGS_INTERNAL_USE = 0x01,
115 HBA_FLAGS_PSCSI_MODE = 0x02,
116};
117
c66ac9db
NB
118/* Special transport agnostic struct se_cmd->t_states */
119enum transport_state_table {
120 TRANSPORT_NO_STATE = 0,
121 TRANSPORT_NEW_CMD = 1,
c66ac9db 122 TRANSPORT_WRITE_PENDING = 3,
c66ac9db 123 TRANSPORT_PROCESSING = 5,
35e0e757 124 TRANSPORT_COMPLETE = 6,
c66ac9db 125 TRANSPORT_ISTATE_PROCESSING = 11,
07bde79a 126 TRANSPORT_COMPLETE_QF_WP = 18,
e057f533 127 TRANSPORT_COMPLETE_QF_OK = 19,
c66ac9db
NB
128};
129
130/* Used for struct se_cmd->se_cmd_flags */
131enum se_cmd_flags_table {
132 SCF_SUPPORTED_SAM_OPCODE = 0x00000001,
133 SCF_TRANSPORT_TASK_SENSE = 0x00000002,
134 SCF_EMULATED_TASK_SENSE = 0x00000004,
64f1db38
CH
135 SCF_SCSI_DATA_CDB = 0x00000008,
136 SCF_SCSI_TMR_CDB = 0x00000010,
64f1db38
CH
137 SCF_FUA = 0x00000080,
138 SCF_SE_LUN_CMD = 0x00000100,
64f1db38
CH
139 SCF_BIDI = 0x00000400,
140 SCF_SENT_CHECK_CONDITION = 0x00000800,
141 SCF_OVERFLOW_BIT = 0x00001000,
142 SCF_UNDERFLOW_BIT = 0x00002000,
68259b5a 143 SCF_SEND_DELAYED_TAS = 0x00004000,
64f1db38 144 SCF_ALUA_NON_OPTIMIZED = 0x00008000,
64f1db38 145 SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00020000,
a82a9538
NB
146 SCF_COMPARE_AND_WRITE = 0x00080000,
147 SCF_COMPARE_AND_WRITE_POST = 0x00100000,
5835812f 148 SCF_PASSTHROUGH_PROT_SG_TO_MEM_NOALLOC = 0x00200000,
c66ac9db
NB
149};
150
151/* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
152enum transport_lunflags_table {
29a05dee
NB
153 TRANSPORT_LUNFLAGS_READ_ONLY = 0x01,
154 TRANSPORT_LUNFLAGS_READ_WRITE = 0x02,
c66ac9db
NB
155};
156
c66ac9db 157/*
de103c93 158 * Used by transport_send_check_condition_and_sense()
c66ac9db
NB
159 * to signal which ASC/ASCQ sense payload should be built.
160 */
de103c93
CH
161typedef unsigned __bitwise__ sense_reason_t;
162
c66ac9db 163enum tcm_sense_reason_table {
de103c93 164#define R(x) (__force sense_reason_t )(x)
ba829137 165 TCM_NO_SENSE = R(0x00),
de103c93
CH
166 TCM_NON_EXISTENT_LUN = R(0x01),
167 TCM_UNSUPPORTED_SCSI_OPCODE = R(0x02),
168 TCM_INCORRECT_AMOUNT_OF_DATA = R(0x03),
169 TCM_UNEXPECTED_UNSOLICITED_DATA = R(0x04),
170 TCM_SERVICE_CRC_ERROR = R(0x05),
171 TCM_SNACK_REJECTED = R(0x06),
172 TCM_SECTOR_COUNT_TOO_MANY = R(0x07),
173 TCM_INVALID_CDB_FIELD = R(0x08),
174 TCM_INVALID_PARAMETER_LIST = R(0x09),
175 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = R(0x0a),
176 TCM_UNKNOWN_MODE_PAGE = R(0x0b),
177 TCM_WRITE_PROTECTED = R(0x0c),
178 TCM_CHECK_CONDITION_ABORT_CMD = R(0x0d),
179 TCM_CHECK_CONDITION_UNIT_ATTENTION = R(0x0e),
180 TCM_CHECK_CONDITION_NOT_READY = R(0x0f),
181 TCM_RESERVATION_CONFLICT = R(0x10),
182 TCM_ADDRESS_OUT_OF_RANGE = R(0x11),
183 TCM_OUT_OF_RESOURCES = R(0x12),
bb992e72 184 TCM_PARAMETER_LIST_LENGTH_ERROR = R(0x13),
818b571c 185 TCM_MISCOMPARE_VERIFY = R(0x14),
fcc4f17b
NB
186 TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED = R(0x15),
187 TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED = R(0x16),
188 TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED = R(0x17),
de103c93 189#undef R
c66ac9db
NB
190};
191
a6360785
NB
192enum target_sc_flags_table {
193 TARGET_SCF_BIDI_OP = 0x01,
194 TARGET_SCF_ACK_KREF = 0x02,
b0d79946 195 TARGET_SCF_UNKNOWN_SIZE = 0x04,
a6360785
NB
196};
197
c4795fb2
CH
198/* fabric independent task management function values */
199enum tcm_tmreq_table {
200 TMR_ABORT_TASK = 1,
201 TMR_ABORT_TASK_SET = 2,
202 TMR_CLEAR_ACA = 3,
203 TMR_CLEAR_TASK_SET = 4,
204 TMR_LUN_RESET = 5,
205 TMR_TARGET_WARM_RESET = 6,
206 TMR_TARGET_COLD_RESET = 7,
c4795fb2
CH
207};
208
209/* fabric independent task management response values */
210enum tcm_tmrsp_table {
a314d700 211 TMR_FUNCTION_FAILED = 0,
11fee8a7
JE
212 TMR_FUNCTION_COMPLETE = 1,
213 TMR_TASK_DOES_NOT_EXIST = 2,
214 TMR_LUN_DOES_NOT_EXIST = 3,
215 TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED = 4,
216 TMR_FUNCTION_REJECTED = 5,
c4795fb2
CH
217};
218
e89d15ee
NB
219/*
220 * Used for target SCSI statistics
221 */
222typedef enum {
223 SCSI_INST_INDEX,
224 SCSI_DEVICE_INDEX,
225 SCSI_AUTH_INTR_INDEX,
226 SCSI_INDEX_TYPE_MAX
227} scsi_index_t;
228
c66ac9db
NB
229struct se_cmd;
230
c66094bf
HR
231struct t10_alua_lba_map_member {
232 struct list_head lba_map_mem_list;
233 int lba_map_mem_alua_state;
234 int lba_map_mem_alua_pg_id;
235};
236
237struct t10_alua_lba_map {
238 u64 lba_map_first_lba;
239 u64 lba_map_last_lba;
240 struct list_head lba_map_list;
241 struct list_head lba_map_mem_list;
242};
243
c66ac9db 244struct t10_alua {
c66ac9db
NB
245 /* ALUA Target Port Group ID */
246 u16 alua_tg_pt_gps_counter;
247 u32 alua_tg_pt_gps_count;
c66094bf
HR
248 /* Referrals support */
249 spinlock_t lba_map_lock;
250 u32 lba_map_segment_size;
251 u32 lba_map_segment_multiplier;
252 struct list_head lba_map_list;
c66ac9db 253 spinlock_t tg_pt_gps_lock;
0fd97ccf 254 struct se_device *t10_dev;
c66ac9db
NB
255 /* Used for default ALUA Target Port Group */
256 struct t10_alua_tg_pt_gp *default_tg_pt_gp;
257 /* Used for default ALUA Target Port Group ConfigFS group */
258 struct config_group alua_tg_pt_gps_group;
c66ac9db 259 struct list_head tg_pt_gps_list;
e0a53e70 260};
c66ac9db
NB
261
262struct t10_alua_lu_gp {
263 u16 lu_gp_id;
264 int lu_gp_valid_id;
265 u32 lu_gp_members;
c66ac9db
NB
266 atomic_t lu_gp_ref_cnt;
267 spinlock_t lu_gp_lock;
268 struct config_group lu_gp_group;
e3d6f909 269 struct list_head lu_gp_node;
c66ac9db 270 struct list_head lu_gp_mem_list;
e0a53e70 271};
c66ac9db
NB
272
273struct t10_alua_lu_gp_member {
5dd7ed2e 274 bool lu_gp_assoc;
c66ac9db
NB
275 atomic_t lu_gp_mem_ref_cnt;
276 spinlock_t lu_gp_mem_lock;
277 struct t10_alua_lu_gp *lu_gp;
278 struct se_device *lu_gp_mem_dev;
279 struct list_head lu_gp_mem_list;
e0a53e70 280};
c66ac9db
NB
281
282struct t10_alua_tg_pt_gp {
283 u16 tg_pt_gp_id;
284 int tg_pt_gp_valid_id;
c0dc941e 285 int tg_pt_gp_alua_supported_states;
dfbce75a
HR
286 int tg_pt_gp_alua_pending_state;
287 int tg_pt_gp_alua_previous_state;
c66ac9db
NB
288 int tg_pt_gp_alua_access_status;
289 int tg_pt_gp_alua_access_type;
290 int tg_pt_gp_nonop_delay_msecs;
291 int tg_pt_gp_trans_delay_msecs;
125d0119 292 int tg_pt_gp_implicit_trans_secs;
c66ac9db
NB
293 int tg_pt_gp_pref;
294 int tg_pt_gp_write_metadata;
c66ac9db
NB
295 u32 tg_pt_gp_members;
296 atomic_t tg_pt_gp_alua_access_state;
297 atomic_t tg_pt_gp_ref_cnt;
298 spinlock_t tg_pt_gp_lock;
299 struct mutex tg_pt_gp_md_mutex;
0fd97ccf 300 struct se_device *tg_pt_gp_dev;
c66ac9db
NB
301 struct config_group tg_pt_gp_group;
302 struct list_head tg_pt_gp_list;
adf653f9
CH
303 struct list_head tg_pt_gp_lun_list;
304 struct se_lun *tg_pt_gp_alua_lun;
9c6e164c
HR
305 struct se_node_acl *tg_pt_gp_alua_nacl;
306 struct delayed_work tg_pt_gp_transition_work;
307 struct completion *tg_pt_gp_transition_complete;
e0a53e70 308};
c66ac9db 309
c66ac9db
NB
310struct t10_vpd {
311 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
312 int protocol_identifier_set;
313 u32 protocol_identifier;
314 u32 device_identifier_code_set;
315 u32 association;
316 u32 device_identifier_type;
317 struct list_head vpd_list;
e0a53e70 318};
c66ac9db
NB
319
320struct t10_wwn {
e3d6f909
AG
321 char vendor[8];
322 char model[16];
323 char revision[4];
324 char unit_serial[INQUIRY_VPD_SERIAL_LEN];
c66ac9db 325 spinlock_t t10_vpd_lock;
0fd97ccf 326 struct se_device *t10_dev;
c66ac9db
NB
327 struct config_group t10_wwn_group;
328 struct list_head t10_vpd_list;
e0a53e70 329};
c66ac9db 330
c66ac9db
NB
331struct t10_pr_registration {
332 /* Used for fabrics that contain WWN+ISID */
333#define PR_REG_ISID_LEN 16
334 /* PR_REG_ISID_LEN + ',i,0x' */
335#define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
336 char pr_reg_isid[PR_REG_ISID_LEN];
337 /* Used during APTPL metadata reading */
338#define PR_APTPL_MAX_IPORT_LEN 256
339 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
340 /* Used during APTPL metadata reading */
341#define PR_APTPL_MAX_TPORT_LEN 256
342 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
c66ac9db
NB
343 u16 pr_aptpl_rpti;
344 u16 pr_reg_tpgt;
345 /* Reservation effects all target ports */
346 int pr_reg_all_tg_pt;
347 /* Activate Persistence across Target Power Loss */
348 int pr_reg_aptpl;
349 int pr_res_holder;
350 int pr_res_type;
351 int pr_res_scope;
352 /* Used for fabric initiator WWPNs using a ISID */
5dd7ed2e 353 bool isid_present_at_reg;
f2d30680
HR
354 u64 pr_res_mapped_lun;
355 u64 pr_aptpl_target_lun;
79dc9c9e 356 u16 tg_pt_sep_rtpi;
c66ac9db
NB
357 u32 pr_res_generation;
358 u64 pr_reg_bin_isid;
359 u64 pr_res_key;
360 atomic_t pr_res_holders;
361 struct se_node_acl *pr_reg_nacl;
79dc9c9e 362 /* Used by ALL_TG_PT=1 registration with deve->pr_ref taken */
c66ac9db 363 struct se_dev_entry *pr_reg_deve;
c66ac9db
NB
364 struct list_head pr_reg_list;
365 struct list_head pr_reg_abort_list;
366 struct list_head pr_reg_aptpl_list;
367 struct list_head pr_reg_atp_list;
368 struct list_head pr_reg_atp_mem_list;
e0a53e70 369};
c66ac9db 370
e3d6f909 371struct t10_reservation {
c66ac9db
NB
372 /* Reservation effects all target ports */
373 int pr_all_tg_pt;
374 /* Activate Persistence across Target Power Loss enabled
375 * for SCSI device */
376 int pr_aptpl_active;
f161d4b4 377#define PR_APTPL_BUF_LEN 262144
c66ac9db 378 u32 pr_generation;
c66ac9db
NB
379 spinlock_t registration_lock;
380 spinlock_t aptpl_reg_lock;
381 /*
382 * This will always be set by one individual I_T Nexus.
383 * However with all_tg_pt=1, other I_T Nexus from the
384 * same initiator can access PR reg/res info on a different
385 * target port.
386 *
387 * There is also the 'All Registrants' case, where there is
388 * a single *pr_res_holder of the reservation, but all
389 * registrations are considered reservation holders.
390 */
391 struct se_node_acl *pr_res_holder;
392 struct list_head registration_list;
393 struct list_head aptpl_reg_list;
e0a53e70 394};
c66ac9db 395
c8e31f26
AG
396struct se_tmr_req {
397 /* Task Management function to be performed */
398 u8 function;
399 /* Task Management response to send */
400 u8 response;
401 int call_transport;
402 /* Reference to ITT that Task Mgmt should be performed */
649ee054 403 u64 ref_task_tag;
c8e31f26
AG
404 void *fabric_tmr_ptr;
405 struct se_cmd *task_cmd;
c8e31f26
AG
406 struct se_device *tmr_dev;
407 struct se_lun *tmr_lun;
408 struct list_head tmr_list;
409};
410
ce65e5b9 411enum target_prot_op {
e70beee7
NB
412 TARGET_PROT_NORMAL = 0,
413 TARGET_PROT_DIN_INSERT = (1 << 0),
414 TARGET_PROT_DOUT_INSERT = (1 << 1),
415 TARGET_PROT_DIN_STRIP = (1 << 2),
416 TARGET_PROT_DOUT_STRIP = (1 << 3),
417 TARGET_PROT_DIN_PASS = (1 << 4),
418 TARGET_PROT_DOUT_PASS = (1 << 5),
ce65e5b9
NB
419};
420
e70beee7
NB
421#define TARGET_PROT_ALL TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \
422 TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \
423 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS
424
ce65e5b9
NB
425enum target_prot_type {
426 TARGET_DIF_TYPE0_PROT,
427 TARGET_DIF_TYPE1_PROT,
428 TARGET_DIF_TYPE2_PROT,
429 TARGET_DIF_TYPE3_PROT,
430};
431
19f9361a
SG
432enum target_core_dif_check {
433 TARGET_DIF_CHECK_GUARD = 0x1 << 0,
434 TARGET_DIF_CHECK_APPTAG = 0x1 << 1,
435 TARGET_DIF_CHECK_REFTAG = 0x1 << 2,
436};
437
ce65e5b9
NB
438struct se_dif_v1_tuple {
439 __be16 guard_tag;
440 __be16 app_tag;
441 __be32 ref_tag;
442};
443
68d81f40
CH
444/* for sam_task_attr */
445#define TCM_SIMPLE_TAG 0x20
446#define TCM_HEAD_TAG 0x21
447#define TCM_ORDERED_TAG 0x22
448#define TCM_ACA_TAG 0x24
449
c66ac9db
NB
450struct se_cmd {
451 /* SAM response code being sent to initiator */
452 u8 scsi_status;
453 u8 scsi_asc;
454 u8 scsi_ascq;
c66ac9db 455 u16 scsi_sense_length;
649ee054 456 u64 tag; /* SAM command identifier aka task tag */
c66ac9db
NB
457 /* Delay for ALUA Active/NonOptimized state access in milliseconds */
458 int alua_nonop_delay;
459 /* See include/linux/dma-mapping.h */
460 enum dma_data_direction data_direction;
461 /* For SAM Task Attribute */
462 int sam_task_attr;
c0add7fd
NB
463 /* Used for se_sess->sess_tag_pool */
464 unsigned int map_tag;
c66ac9db
NB
465 /* Transport protocol dependent state, see transport_state_table */
466 enum transport_state_table t_state;
5f655e8d 467 unsigned cmd_wait_set:1;
b0d79946 468 unsigned unknown_data_length:1;
c66ac9db
NB
469 /* See se_cmd_flags_table */
470 u32 se_cmd_flags;
471 u32 se_ordered_id;
472 /* Total size in bytes associated with command */
473 u32 data_length;
c66ac9db 474 u32 residual_count;
f2d30680 475 u64 orig_fe_lun;
c66ac9db
NB
476 /* Persistent Reservation key */
477 u64 pr_res_key;
c66ac9db
NB
478 /* Used for sense data */
479 void *sense_buffer;
5951146d 480 struct list_head se_delayed_node;
07bde79a 481 struct list_head se_qf_node;
c66ac9db 482 struct se_device *se_dev;
c66ac9db
NB
483 struct se_lun *se_lun;
484 /* Only used for internal passthrough and legacy TCM fabric modules */
485 struct se_session *se_sess;
486 struct se_tmr_req *se_tmr_req;
a17f091d
NB
487 struct list_head se_cmd_list;
488 struct completion cmd_wait_comp;
7481deb4 489 struct kref cmd_kref;
9ac8928e 490 const struct target_core_fabric_ops *se_tfo;
de103c93 491 sense_reason_t (*execute_cmd)(struct se_cmd *);
c8e63985 492 sense_reason_t (*transport_complete_callback)(struct se_cmd *, bool);
7a971b1b 493 void *protocol_data;
07bde79a 494
a1d8b49a
AG
495 unsigned char *t_task_cdb;
496 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
497 unsigned long long t_task_lba;
a82a9538 498 unsigned int t_task_nolb;
7d680f3b
CH
499 unsigned int transport_state;
500#define CMD_T_ABORTED (1 << 0)
501#define CMD_T_ACTIVE (1 << 1)
502#define CMD_T_COMPLETE (1 << 2)
7d680f3b
CH
503#define CMD_T_SENT (1 << 4)
504#define CMD_T_STOP (1 << 5)
4a9a6c8d
NB
505#define CMD_T_DEV_ACTIVE (1 << 7)
506#define CMD_T_REQUEST_STOP (1 << 8)
507#define CMD_T_BUSY (1 << 9)
a1d8b49a
AG
508 spinlock_t t_state_lock;
509 struct completion t_transport_stop_comp;
05d1c7c0 510
35e0e757
CH
511 struct work_struct work;
512
ec98f782 513 struct scatterlist *t_data_sg;
47e459e6 514 struct scatterlist *t_data_sg_orig;
ec98f782 515 unsigned int t_data_nents;
47e459e6 516 unsigned int t_data_nents_orig;
4949314c 517 void *t_data_vmap;
ec98f782
AG
518 struct scatterlist *t_bidi_data_sg;
519 unsigned int t_bidi_data_nents;
520
cf572a96
CH
521 struct list_head state_list;
522 bool state_active;
523
524 /* old task stop completion, consider merging with some of the above */
525 struct completion task_stop_comp;
526
5787cacd
CH
527 /* backend private data */
528 void *priv;
5277797d
NB
529
530 /* Used for lun->lun_ref counting */
5259a06e 531 int lun_ref_active;
ce65e5b9
NB
532
533 /* DIF related members */
534 enum target_prot_op prot_op;
535 enum target_prot_type prot_type;
19f9361a 536 u8 prot_checks;
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;
76736db3 542 sector_t bad_sector;
b5b8e298 543 bool prot_pto;
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;
337c0607 556 bool acl_stop:1;
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
NB
573 struct config_group acl_fabric_stat_group;
574 struct config_group *acl_default_groups[5];
c66ac9db
NB
575 struct list_head acl_list;
576 struct list_head acl_sess_list;
01468346 577 struct completion acl_free_comp;
afb999ff 578 struct kref acl_kref;
e0a53e70 579};
c66ac9db
NB
580
581struct se_session {
5f655e8d 582 unsigned sess_tearing_down:1;
c66ac9db 583 u64 sess_bin_isid;
e70beee7 584 enum target_prot_op sup_prot_ops;
38b57f82 585 enum target_prot_type sess_prot_type;
c66ac9db
NB
586 struct se_node_acl *se_node_acl;
587 struct se_portal_group *se_tpg;
588 void *fabric_sess_ptr;
589 struct list_head sess_list;
590 struct list_head sess_acl_list;
a17f091d 591 struct list_head sess_cmd_list;
9b31a328 592 struct list_head sess_wait_list;
a17f091d 593 spinlock_t sess_cmd_lock;
41ac82b6 594 struct kref sess_kref;
c0add7fd
NB
595 void *sess_cmd_map;
596 struct percpu_ida sess_tag_pool;
e0a53e70 597};
c66ac9db 598
c66ac9db
NB
599struct se_device;
600struct se_transform_info;
601struct scatterlist;
602
12d23384
NB
603struct se_ml_stat_grps {
604 struct config_group stat_group;
605 struct config_group scsi_auth_intr_group;
606 struct config_group scsi_att_intr_port_group;
607};
608
c66ac9db
NB
609struct se_lun_acl {
610 char initiatorname[TRANSPORT_IQN_LEN];
f2d30680 611 u64 mapped_lun;
c66ac9db
NB
612 struct se_node_acl *se_lun_nacl;
613 struct se_lun *se_lun;
c66ac9db 614 struct config_group se_lun_group;
12d23384 615 struct se_ml_stat_grps ml_stat_grps;
e0a53e70 616};
c66ac9db
NB
617
618struct se_dev_entry {
c66ac9db 619 /* See transport_lunflags_table */
f2d30680 620 u64 mapped_lun;
c66ac9db
NB
621 u64 pr_res_key;
622 u64 creation_time;
f2d30680 623 u32 lun_flags;
c66ac9db 624 u32 attach_count;
29a05dee
NB
625 atomic_long_t total_cmds;
626 atomic_long_t read_bytes;
627 atomic_long_t write_bytes;
c66ac9db
NB
628 atomic_t ua_count;
629 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
29a05dee
NB
630 struct kref pr_kref;
631 struct completion pr_comp;
632 struct se_lun_acl __rcu *se_lun_acl;
c66ac9db 633 spinlock_t ua_lock;
29a05dee 634 struct se_lun __rcu *se_lun;
80bfdfa9
NB
635#define DEF_PR_REG_ACTIVE 1
636 unsigned long deve_flags;
c66ac9db 637 struct list_head alua_port_list;
adf653f9 638 struct list_head lun_link;
c66ac9db 639 struct list_head ua_list;
29a05dee
NB
640 struct hlist_node link;
641 struct rcu_head rcu_head;
e0a53e70 642};
c66ac9db 643
c66ac9db 644struct se_dev_attrib {
adfa9570 645 int emulate_model_alias;
c66ac9db
NB
646 int emulate_dpo;
647 int emulate_fua_write;
648 int emulate_fua_read;
649 int emulate_write_cache;
650 int emulate_ua_intlck_ctrl;
651 int emulate_tas;
652 int emulate_tpu;
653 int emulate_tpws;
0123a9ec 654 int emulate_caw;
d397a445 655 int emulate_3pc;
ce65e5b9
NB
656 int pi_prot_format;
657 enum target_prot_type pi_prot_type;
658 enum target_prot_type hw_pi_prot_type;
c66ac9db 659 int enforce_pr_isids;
92404e60 660 int force_pr_aptpl;
e22a7f07 661 int is_nonrot;
5de619a3 662 int emulate_rest_reord;
c66ac9db
NB
663 u32 hw_block_size;
664 u32 block_size;
665 u32 hw_max_sectors;
c66ac9db
NB
666 u32 optimal_sectors;
667 u32 hw_queue_depth;
668 u32 queue_depth;
c66ac9db
NB
669 u32 max_unmap_lba_count;
670 u32 max_unmap_block_desc_count;
671 u32 unmap_granularity;
672 u32 unmap_granularity_alignment;
773cbaf7 673 u32 max_write_same_len;
95cadace 674 u32 max_bytes_per_io;
0fd97ccf 675 struct se_device *da_dev;
c66ac9db 676 struct config_group da_group;
e0a53e70 677};
c66ac9db 678
4863e525
NB
679struct se_port_stat_grps {
680 struct config_group stat_group;
681 struct config_group scsi_port_group;
682 struct config_group scsi_tgt_port_group;
683 struct config_group scsi_transport_group;
684};
685
adf653f9 686struct scsi_port_stats {
4cc987ea
NB
687 atomic_long_t cmd_pdus;
688 atomic_long_t tx_data_octets;
689 atomic_long_t rx_data_octets;
adf653f9
CH
690};
691
4863e525 692struct se_lun {
f2d30680 693 u64 unpacked_lun;
4863e525
NB
694#define SE_LUN_LINK_MAGIC 0xffff7771
695 u32 lun_link_magic;
4863e525
NB
696 u32 lun_access;
697 u32 lun_flags;
29a05dee 698 u32 lun_index;
f2d30680
HR
699
700 /* RELATIVE TARGET PORT IDENTIFER */
701 u16 lun_rtpi;
4863e525 702 atomic_t lun_acl_count;
adf653f9
CH
703 struct se_device __rcu *lun_se_dev;
704
705 struct list_head lun_deve_list;
706 spinlock_t lun_deve_lock;
707
708 /* ALUA state */
709 int lun_tg_pt_secondary_stat;
710 int lun_tg_pt_secondary_write_md;
711 atomic_t lun_tg_pt_secondary_offline;
712 struct mutex lun_tg_pt_md_mutex;
713
714 /* ALUA target port group linkage */
715 struct list_head lun_tg_pt_gp_link;
716 struct t10_alua_tg_pt_gp *lun_tg_pt_gp;
717 spinlock_t lun_tg_pt_gp_lock;
718
adf653f9
CH
719 struct se_portal_group *lun_tpg;
720 struct scsi_port_stats lun_stats;
4863e525
NB
721 struct config_group lun_group;
722 struct se_port_stat_grps port_stat_grps;
723 struct completion lun_ref_comp;
724 struct percpu_ref lun_ref;
adf653f9 725 struct list_head lun_dev_link;
6bb82612
NB
726 struct hlist_node link;
727 struct rcu_head rcu_head;
4863e525
NB
728};
729
12d23384
NB
730struct se_dev_stat_grps {
731 struct config_group stat_group;
732 struct config_group scsi_dev_group;
733 struct config_group scsi_tgt_dev_group;
734 struct config_group scsi_lu_group;
735};
736
c66ac9db 737struct se_device {
0ff87549
NB
738#define SE_DEV_LINK_MAGIC 0xfeeddeef
739 u32 dev_link_magic;
c66ac9db
NB
740 /* RELATIVE TARGET PORT IDENTIFER Counter */
741 u16 dev_rpti_counter;
742 /* Used for SAM Task Attribute ordering */
743 u32 dev_cur_ordered_id;
744 u32 dev_flags;
0fd97ccf
CH
745#define DF_CONFIGURED 0x00000001
746#define DF_FIRMWARE_VPD_UNIT_SERIAL 0x00000002
747#define DF_EMULATED_VPD_UNIT_SERIAL 0x00000004
748#define DF_USING_UDEV_PATH 0x00000008
749#define DF_USING_ALIAS 0x00000010
c66ac9db
NB
750 /* Physical device queue depth */
751 u32 queue_depth;
752 /* Used for SPC-2 reservations enforce of ISIDs */
753 u64 dev_res_bin_isid;
c66ac9db 754 /* Pointer to transport specific device structure */
c66ac9db
NB
755 u32 dev_index;
756 u64 creation_time;
ee480683
NB
757 atomic_long_t num_resets;
758 atomic_long_t num_cmds;
759 atomic_long_t read_bytes;
760 atomic_long_t write_bytes;
c66ac9db 761 /* Active commands on this virtual SE device */
c66ac9db 762 atomic_t simple_cmds;
c66ac9db 763 atomic_t dev_ordered_id;
c66ac9db 764 atomic_t dev_ordered_sync;
07bde79a 765 atomic_t dev_qf_count;
adf653f9 766 u32 export_count;
c66ac9db 767 spinlock_t delayed_cmd_lock;
c66ac9db 768 spinlock_t execute_task_lock;
c66ac9db 769 spinlock_t dev_reservation_lock;
0fd97ccf
CH
770 unsigned int dev_reservation_flags;
771#define DRF_SPC2_RESERVATIONS 0x00000001
772#define DRF_SPC2_RESERVATIONS_WITH_ISID 0x00000002
c66ac9db
NB
773 spinlock_t se_port_lock;
774 spinlock_t se_tmr_lock;
07bde79a 775 spinlock_t qf_cmd_lock;
68ff9b9b 776 struct semaphore caw_sem;
c66ac9db
NB
777 /* Used for legacy SPC-2 reservationsa */
778 struct se_node_acl *dev_reserved_node_acl;
779 /* Used for ALUA Logical Unit Group membership */
780 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
781 /* Used for SPC-3 Persistent Reservations */
782 struct t10_pr_registration *dev_pr_res_holder;
783 struct list_head dev_sep_list;
784 struct list_head dev_tmr_list;
af877292 785 struct workqueue_struct *tmr_wq;
07bde79a 786 struct work_struct qf_work_queue;
c66ac9db 787 struct list_head delayed_cmd_list;
cf572a96 788 struct list_head state_list;
07bde79a 789 struct list_head qf_cmd_list;
d9ea32bf 790 struct list_head g_dev_node;
c66ac9db
NB
791 /* Pointer to associated SE HBA */
792 struct se_hba *se_hba;
0fd97ccf
CH
793 /* T10 Inquiry and VPD WWN Information */
794 struct t10_wwn t10_wwn;
795 /* T10 Asymmetric Logical Unit Assignment for Target Ports */
796 struct t10_alua t10_alua;
797 /* T10 SPC-2 + SPC-3 Reservations */
798 struct t10_reservation t10_pr;
799 struct se_dev_attrib dev_attrib;
800 struct config_group dev_group;
801 struct config_group dev_pr_group;
802 struct se_dev_stat_grps dev_stat_grps;
803#define SE_DEV_ALIAS_LEN 512 /* must be less than PAGE_SIZE */
804 unsigned char dev_alias[SE_DEV_ALIAS_LEN];
805#define SE_UDEV_PATH_LEN 512 /* must be less than PAGE_SIZE */
806 unsigned char udev_path[SE_UDEV_PATH_LEN];
c66ac9db 807 /* Pointer to template of function pointers for transport */
0a06d430 808 const struct target_backend_ops *transport;
c66ac9db
NB
809 /* Linked list for struct se_hba struct se_device list */
810 struct list_head dev_list;
4863e525 811 struct se_lun xcopy_lun;
ce65e5b9
NB
812 /* Protection Information */
813 int prot_length;
4cc987ea
NB
814 /* For se_lun->lun_se_dev RCU read-side critical access */
815 u32 hba_index;
816 struct rcu_head rcu_head;
e0a53e70 817};
c66ac9db 818
c66ac9db
NB
819struct se_hba {
820 u16 hba_tpgt;
821 u32 hba_id;
822 /* See hba_flags_table */
823 u32 hba_flags;
824 /* Virtual iSCSI devices attached. */
825 u32 dev_count;
826 u32 hba_index;
c66ac9db
NB
827 /* Pointer to transport specific host structure. */
828 void *hba_ptr;
e3d6f909 829 struct list_head hba_node;
c66ac9db 830 spinlock_t device_lock;
c66ac9db
NB
831 struct config_group hba_group;
832 struct mutex hba_access_mutex;
0a06d430 833 struct target_backend *backend;
e0a53e70 834};
c66ac9db 835
c66ac9db 836struct se_tpg_np {
1f6fe7cb 837 struct se_portal_group *tpg_np_parent;
c66ac9db 838 struct config_group tpg_np_group;
e0a53e70 839};
c66ac9db
NB
840
841struct se_portal_group {
e4aae5af
CH
842 /*
843 * PROTOCOL IDENTIFIER value per SPC4, 7.5.1.
844 *
845 * Negative values can be used by fabric drivers for internal use TPGs.
846 */
847 int proto_id;
c66ac9db
NB
848 /* Number of ACLed Initiator Nodes for this TPG */
849 u32 num_node_acls;
850 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
851 atomic_t tpg_pr_ref_count;
852 /* Spinlock for adding/removing ACLed Nodes */
403edd78 853 struct mutex acl_node_mutex;
c66ac9db
NB
854 /* Spinlock for adding/removing sessions */
855 spinlock_t session_lock;
6bb82612 856 struct mutex tpg_lun_mutex;
e3d6f909 857 struct list_head se_tpg_node;
c66ac9db
NB
858 /* linked list for initiator ACL list */
859 struct list_head acl_node_list;
6bb82612 860 struct hlist_head tpg_lun_hlist;
adf653f9 861 struct se_lun *tpg_virt_lun0;
25985edc 862 /* List of TCM sessions associated wth this TPG */
c66ac9db
NB
863 struct list_head tpg_sess_list;
864 /* Pointer to $FABRIC_MOD dependent code */
9ac8928e 865 const struct target_core_fabric_ops *se_tpg_tfo;
c66ac9db
NB
866 struct se_wwn *se_tpg_wwn;
867 struct config_group tpg_group;
e4b512e7 868 struct config_group *tpg_default_groups[7];
c66ac9db
NB
869 struct config_group tpg_lun_group;
870 struct config_group tpg_np_group;
871 struct config_group tpg_acl_group;
872 struct config_group tpg_attrib_group;
e4b512e7 873 struct config_group tpg_auth_group;
c66ac9db 874 struct config_group tpg_param_group;
e0a53e70 875};
c66ac9db 876
c66ac9db
NB
877struct se_wwn {
878 struct target_fabric_configfs *wwn_tf;
879 struct config_group wwn_group;
12d23384
NB
880 struct config_group *wwn_default_groups[2];
881 struct config_group fabric_stat_group;
e0a53e70 882};
c66ac9db 883
33940d09
JE
884static inline void atomic_inc_mb(atomic_t *v)
885{
886 smp_mb__before_atomic();
887 atomic_inc(v);
888 smp_mb__after_atomic();
889}
890
891static inline void atomic_dec_mb(atomic_t *v)
892{
893 smp_mb__before_atomic();
894 atomic_dec(v);
895 smp_mb__after_atomic();
896}
897
c66ac9db 898#endif /* TARGET_CORE_BASE_H */