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