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