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