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