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