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