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