]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/target/target_core_base.h
target: Add percpu refcounting for se_lun access
[mirror_ubuntu-artful-kernel.git] / include / target / target_core_base.h
CommitLineData
c66ac9db
NB
1#ifndef TARGET_CORE_BASE_H
2#define TARGET_CORE_BASE_H
3
4#include <linux/in.h>
5#include <linux/configfs.h>
6#include <linux/dma-mapping.h>
7#include <linux/blkdev.h>
c0add7fd 8#include <linux/percpu_ida.h>
c66ac9db
NB
9#include <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
d95b8246 115#define SE_INQUIRY_BUF 512
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
250struct t10_alua {
c66ac9db
NB
251 /* ALUA Target Port Group ID */
252 u16 alua_tg_pt_gps_counter;
253 u32 alua_tg_pt_gps_count;
254 spinlock_t tg_pt_gps_lock;
0fd97ccf 255 struct se_device *t10_dev;
c66ac9db
NB
256 /* Used for default ALUA Target Port Group */
257 struct t10_alua_tg_pt_gp *default_tg_pt_gp;
258 /* Used for default ALUA Target Port Group ConfigFS group */
259 struct config_group alua_tg_pt_gps_group;
c66ac9db 260 struct list_head tg_pt_gps_list;
e0a53e70 261};
c66ac9db
NB
262
263struct t10_alua_lu_gp {
264 u16 lu_gp_id;
265 int lu_gp_valid_id;
266 u32 lu_gp_members;
c66ac9db
NB
267 atomic_t lu_gp_ref_cnt;
268 spinlock_t lu_gp_lock;
269 struct config_group lu_gp_group;
e3d6f909 270 struct list_head lu_gp_node;
c66ac9db 271 struct list_head lu_gp_mem_list;
e0a53e70 272};
c66ac9db
NB
273
274struct t10_alua_lu_gp_member {
5dd7ed2e 275 bool lu_gp_assoc;
c66ac9db
NB
276 atomic_t lu_gp_mem_ref_cnt;
277 spinlock_t lu_gp_mem_lock;
278 struct t10_alua_lu_gp *lu_gp;
279 struct se_device *lu_gp_mem_dev;
280 struct list_head lu_gp_mem_list;
e0a53e70 281};
c66ac9db
NB
282
283struct t10_alua_tg_pt_gp {
284 u16 tg_pt_gp_id;
285 int tg_pt_gp_valid_id;
286 int tg_pt_gp_alua_access_status;
287 int tg_pt_gp_alua_access_type;
288 int tg_pt_gp_nonop_delay_msecs;
289 int tg_pt_gp_trans_delay_msecs;
5b9a4d72 290 int tg_pt_gp_implict_trans_secs;
c66ac9db
NB
291 int tg_pt_gp_pref;
292 int tg_pt_gp_write_metadata;
293 /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
294#define ALUA_MD_BUF_LEN 1024
295 u32 tg_pt_gp_md_buf_len;
296 u32 tg_pt_gp_members;
297 atomic_t tg_pt_gp_alua_access_state;
298 atomic_t tg_pt_gp_ref_cnt;
299 spinlock_t tg_pt_gp_lock;
300 struct mutex tg_pt_gp_md_mutex;
0fd97ccf 301 struct se_device *tg_pt_gp_dev;
c66ac9db
NB
302 struct config_group tg_pt_gp_group;
303 struct list_head tg_pt_gp_list;
304 struct list_head tg_pt_gp_mem_list;
e0a53e70 305};
c66ac9db
NB
306
307struct t10_alua_tg_pt_gp_member {
5dd7ed2e 308 bool tg_pt_gp_assoc;
c66ac9db
NB
309 atomic_t tg_pt_gp_mem_ref_cnt;
310 spinlock_t tg_pt_gp_mem_lock;
311 struct t10_alua_tg_pt_gp *tg_pt_gp;
312 struct se_port *tg_pt;
313 struct list_head tg_pt_gp_mem_list;
e0a53e70 314};
c66ac9db
NB
315
316struct t10_vpd {
317 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
318 int protocol_identifier_set;
319 u32 protocol_identifier;
320 u32 device_identifier_code_set;
321 u32 association;
322 u32 device_identifier_type;
323 struct list_head vpd_list;
e0a53e70 324};
c66ac9db
NB
325
326struct t10_wwn {
e3d6f909
AG
327 char vendor[8];
328 char model[16];
329 char revision[4];
330 char unit_serial[INQUIRY_VPD_SERIAL_LEN];
c66ac9db 331 spinlock_t t10_vpd_lock;
0fd97ccf 332 struct se_device *t10_dev;
c66ac9db
NB
333 struct config_group t10_wwn_group;
334 struct list_head t10_vpd_list;
e0a53e70 335};
c66ac9db 336
c66ac9db
NB
337struct t10_pr_registration {
338 /* Used for fabrics that contain WWN+ISID */
339#define PR_REG_ISID_LEN 16
340 /* PR_REG_ISID_LEN + ',i,0x' */
341#define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
342 char pr_reg_isid[PR_REG_ISID_LEN];
343 /* Used during APTPL metadata reading */
344#define PR_APTPL_MAX_IPORT_LEN 256
345 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
346 /* Used during APTPL metadata reading */
347#define PR_APTPL_MAX_TPORT_LEN 256
348 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
c66ac9db
NB
349 u16 pr_aptpl_rpti;
350 u16 pr_reg_tpgt;
351 /* Reservation effects all target ports */
352 int pr_reg_all_tg_pt;
353 /* Activate Persistence across Target Power Loss */
354 int pr_reg_aptpl;
355 int pr_res_holder;
356 int pr_res_type;
357 int pr_res_scope;
358 /* Used for fabric initiator WWPNs using a ISID */
5dd7ed2e 359 bool isid_present_at_reg;
c66ac9db
NB
360 u32 pr_res_mapped_lun;
361 u32 pr_aptpl_target_lun;
362 u32 pr_res_generation;
363 u64 pr_reg_bin_isid;
364 u64 pr_res_key;
365 atomic_t pr_res_holders;
366 struct se_node_acl *pr_reg_nacl;
367 struct se_dev_entry *pr_reg_deve;
368 struct se_lun *pr_reg_tg_pt_lun;
369 struct list_head pr_reg_list;
370 struct list_head pr_reg_abort_list;
371 struct list_head pr_reg_aptpl_list;
372 struct list_head pr_reg_atp_list;
373 struct list_head pr_reg_atp_mem_list;
e0a53e70 374};
c66ac9db 375
e3d6f909 376struct t10_reservation {
c66ac9db
NB
377 /* Reservation effects all target ports */
378 int pr_all_tg_pt;
379 /* Activate Persistence across Target Power Loss enabled
380 * for SCSI device */
381 int pr_aptpl_active;
c66ac9db 382#define PR_APTPL_BUF_LEN 8192
c66ac9db 383 u32 pr_generation;
c66ac9db
NB
384 spinlock_t registration_lock;
385 spinlock_t aptpl_reg_lock;
386 /*
387 * This will always be set by one individual I_T Nexus.
388 * However with all_tg_pt=1, other I_T Nexus from the
389 * same initiator can access PR reg/res info on a different
390 * target port.
391 *
392 * There is also the 'All Registrants' case, where there is
393 * a single *pr_res_holder of the reservation, but all
394 * registrations are considered reservation holders.
395 */
396 struct se_node_acl *pr_res_holder;
397 struct list_head registration_list;
398 struct list_head aptpl_reg_list;
e0a53e70 399};
c66ac9db 400
c8e31f26
AG
401struct se_tmr_req {
402 /* Task Management function to be performed */
403 u8 function;
404 /* Task Management response to send */
405 u8 response;
406 int call_transport;
407 /* Reference to ITT that Task Mgmt should be performed */
408 u32 ref_task_tag;
c8e31f26
AG
409 void *fabric_tmr_ptr;
410 struct se_cmd *task_cmd;
c8e31f26
AG
411 struct se_device *tmr_dev;
412 struct se_lun *tmr_lun;
413 struct list_head tmr_list;
414};
415
c66ac9db
NB
416struct se_cmd {
417 /* SAM response code being sent to initiator */
418 u8 scsi_status;
419 u8 scsi_asc;
420 u8 scsi_ascq;
c66ac9db
NB
421 u16 scsi_sense_length;
422 /* Delay for ALUA Active/NonOptimized state access in milliseconds */
423 int alua_nonop_delay;
424 /* See include/linux/dma-mapping.h */
425 enum dma_data_direction data_direction;
426 /* For SAM Task Attribute */
427 int sam_task_attr;
c0add7fd
NB
428 /* Used for se_sess->sess_tag_pool */
429 unsigned int map_tag;
c66ac9db
NB
430 /* Transport protocol dependent state, see transport_state_table */
431 enum transport_state_table t_state;
5f655e8d 432 unsigned cmd_wait_set:1;
b0d79946 433 unsigned unknown_data_length:1;
c66ac9db
NB
434 /* See se_cmd_flags_table */
435 u32 se_cmd_flags;
436 u32 se_ordered_id;
437 /* Total size in bytes associated with command */
438 u32 data_length;
c66ac9db
NB
439 u32 residual_count;
440 u32 orig_fe_lun;
441 /* Persistent Reservation key */
442 u64 pr_res_key;
c66ac9db
NB
443 /* Used for sense data */
444 void *sense_buffer;
5951146d 445 struct list_head se_delayed_node;
5951146d 446 struct list_head se_lun_node;
07bde79a 447 struct list_head se_qf_node;
c66ac9db
NB
448 struct se_device *se_dev;
449 struct se_dev_entry *se_deve;
c66ac9db
NB
450 struct se_lun *se_lun;
451 /* Only used for internal passthrough and legacy TCM fabric modules */
452 struct se_session *se_sess;
453 struct se_tmr_req *se_tmr_req;
a17f091d
NB
454 struct list_head se_cmd_list;
455 struct completion cmd_wait_comp;
7481deb4 456 struct kref cmd_kref;
c66ac9db 457 struct target_core_fabric_ops *se_tfo;
de103c93 458 sense_reason_t (*execute_cmd)(struct se_cmd *);
a82a9538
NB
459 sense_reason_t (*execute_rw)(struct se_cmd *, struct scatterlist *,
460 u32, enum dma_data_direction);
a6b0133c 461 sense_reason_t (*transport_complete_callback)(struct se_cmd *);
07bde79a 462
a1d8b49a
AG
463 unsigned char *t_task_cdb;
464 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
465 unsigned long long t_task_lba;
a82a9538 466 unsigned int t_task_nolb;
7d680f3b
CH
467 unsigned int transport_state;
468#define CMD_T_ABORTED (1 << 0)
469#define CMD_T_ACTIVE (1 << 1)
470#define CMD_T_COMPLETE (1 << 2)
7d680f3b
CH
471#define CMD_T_SENT (1 << 4)
472#define CMD_T_STOP (1 << 5)
473#define CMD_T_FAILED (1 << 6)
474#define CMD_T_LUN_STOP (1 << 7)
475#define CMD_T_LUN_FE_STOP (1 << 8)
476#define CMD_T_DEV_ACTIVE (1 << 9)
cf572a96
CH
477#define CMD_T_REQUEST_STOP (1 << 10)
478#define CMD_T_BUSY (1 << 11)
a1d8b49a
AG
479 spinlock_t t_state_lock;
480 struct completion t_transport_stop_comp;
481 struct completion transport_lun_fe_stop_comp;
482 struct completion transport_lun_stop_comp;
05d1c7c0 483
35e0e757
CH
484 struct work_struct work;
485
ec98f782 486 struct scatterlist *t_data_sg;
47e459e6 487 struct scatterlist *t_data_sg_orig;
ec98f782 488 unsigned int t_data_nents;
47e459e6 489 unsigned int t_data_nents_orig;
4949314c 490 void *t_data_vmap;
ec98f782
AG
491 struct scatterlist *t_bidi_data_sg;
492 unsigned int t_bidi_data_nents;
493
cf572a96
CH
494 struct list_head state_list;
495 bool state_active;
496
497 /* old task stop completion, consider merging with some of the above */
498 struct completion task_stop_comp;
499
5787cacd
CH
500 /* backend private data */
501 void *priv;
5277797d
NB
502
503 /* Used for lun->lun_ref counting */
504 bool lun_ref_active;
e0a53e70 505};
c66ac9db 506
c66ac9db
NB
507struct se_ua {
508 u8 ua_asc;
509 u8 ua_ascq;
510 struct se_node_acl *ua_nacl;
511 struct list_head ua_dev_list;
512 struct list_head ua_nacl_list;
e0a53e70 513};
c66ac9db
NB
514
515struct se_node_acl {
516 char initiatorname[TRANSPORT_IQN_LEN];
517 /* Used to signal demo mode created ACL, disabled by default */
5dd7ed2e 518 bool dynamic_node_acl;
337c0607 519 bool acl_stop:1;
c66ac9db
NB
520 u32 queue_depth;
521 u32 acl_index;
79e62fc3
AG
522#define MAX_ACL_TAG_SIZE 64
523 char acl_tag[MAX_ACL_TAG_SIZE];
c66ac9db
NB
524 u64 num_cmds;
525 u64 read_bytes;
526 u64 write_bytes;
527 spinlock_t stats_lock;
528 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
529 atomic_t acl_pr_ref_count;
f2083241 530 struct se_dev_entry **device_list;
c66ac9db
NB
531 struct se_session *nacl_sess;
532 struct se_portal_group *se_tpg;
533 spinlock_t device_list_lock;
534 spinlock_t nacl_sess_lock;
535 struct config_group acl_group;
536 struct config_group acl_attrib_group;
537 struct config_group acl_auth_group;
538 struct config_group acl_param_group;
12d23384
NB
539 struct config_group acl_fabric_stat_group;
540 struct config_group *acl_default_groups[5];
c66ac9db
NB
541 struct list_head acl_list;
542 struct list_head acl_sess_list;
01468346 543 struct completion acl_free_comp;
afb999ff 544 struct kref acl_kref;
e0a53e70 545};
c66ac9db
NB
546
547struct se_session {
5f655e8d 548 unsigned sess_tearing_down:1;
c66ac9db
NB
549 u64 sess_bin_isid;
550 struct se_node_acl *se_node_acl;
551 struct se_portal_group *se_tpg;
552 void *fabric_sess_ptr;
553 struct list_head sess_list;
554 struct list_head sess_acl_list;
a17f091d 555 struct list_head sess_cmd_list;
9b31a328 556 struct list_head sess_wait_list;
a17f091d 557 spinlock_t sess_cmd_lock;
41ac82b6 558 struct kref sess_kref;
c0add7fd
NB
559 void *sess_cmd_map;
560 struct percpu_ida sess_tag_pool;
e0a53e70 561};
c66ac9db 562
c66ac9db
NB
563struct se_device;
564struct se_transform_info;
565struct scatterlist;
566
12d23384
NB
567struct se_ml_stat_grps {
568 struct config_group stat_group;
569 struct config_group scsi_auth_intr_group;
570 struct config_group scsi_att_intr_port_group;
571};
572
c66ac9db
NB
573struct se_lun_acl {
574 char initiatorname[TRANSPORT_IQN_LEN];
575 u32 mapped_lun;
576 struct se_node_acl *se_lun_nacl;
577 struct se_lun *se_lun;
578 struct list_head lacl_list;
579 struct config_group se_lun_group;
12d23384 580 struct se_ml_stat_grps ml_stat_grps;
e0a53e70 581};
c66ac9db
NB
582
583struct se_dev_entry {
5dd7ed2e 584 bool def_pr_registered;
c66ac9db
NB
585 /* See transport_lunflags_table */
586 u32 lun_flags;
c66ac9db 587 u32 mapped_lun;
c66ac9db 588 u32 total_cmds;
c66ac9db
NB
589 u64 pr_res_key;
590 u64 creation_time;
591 u32 attach_count;
592 u64 read_bytes;
593 u64 write_bytes;
594 atomic_t ua_count;
595 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
596 atomic_t pr_ref_count;
597 struct se_lun_acl *se_lun_acl;
598 spinlock_t ua_lock;
599 struct se_lun *se_lun;
600 struct list_head alua_port_list;
601 struct list_head ua_list;
e0a53e70 602};
c66ac9db 603
c66ac9db 604struct se_dev_attrib {
adfa9570 605 int emulate_model_alias;
c66ac9db
NB
606 int emulate_dpo;
607 int emulate_fua_write;
608 int emulate_fua_read;
609 int emulate_write_cache;
610 int emulate_ua_intlck_ctrl;
611 int emulate_tas;
612 int emulate_tpu;
613 int emulate_tpws;
0123a9ec 614 int emulate_caw;
d397a445 615 int emulate_3pc;
c66ac9db 616 int enforce_pr_isids;
e22a7f07 617 int is_nonrot;
5de619a3 618 int emulate_rest_reord;
c66ac9db
NB
619 u32 hw_block_size;
620 u32 block_size;
621 u32 hw_max_sectors;
015487b8 622 u32 fabric_max_sectors;
c66ac9db
NB
623 u32 optimal_sectors;
624 u32 hw_queue_depth;
625 u32 queue_depth;
c66ac9db
NB
626 u32 max_unmap_lba_count;
627 u32 max_unmap_block_desc_count;
628 u32 unmap_granularity;
629 u32 unmap_granularity_alignment;
773cbaf7 630 u32 max_write_same_len;
0fd97ccf 631 struct se_device *da_dev;
c66ac9db 632 struct config_group da_group;
e0a53e70 633};
c66ac9db 634
12d23384
NB
635struct se_dev_stat_grps {
636 struct config_group stat_group;
637 struct config_group scsi_dev_group;
638 struct config_group scsi_tgt_dev_group;
639 struct config_group scsi_lu_group;
640};
641
c66ac9db 642struct se_device {
0ff87549
NB
643#define SE_DEV_LINK_MAGIC 0xfeeddeef
644 u32 dev_link_magic;
c66ac9db
NB
645 /* RELATIVE TARGET PORT IDENTIFER Counter */
646 u16 dev_rpti_counter;
647 /* Used for SAM Task Attribute ordering */
648 u32 dev_cur_ordered_id;
649 u32 dev_flags;
0fd97ccf
CH
650#define DF_CONFIGURED 0x00000001
651#define DF_FIRMWARE_VPD_UNIT_SERIAL 0x00000002
652#define DF_EMULATED_VPD_UNIT_SERIAL 0x00000004
653#define DF_USING_UDEV_PATH 0x00000008
654#define DF_USING_ALIAS 0x00000010
c66ac9db 655 u32 dev_port_count;
c66ac9db
NB
656 /* Physical device queue depth */
657 u32 queue_depth;
658 /* Used for SPC-2 reservations enforce of ISIDs */
659 u64 dev_res_bin_isid;
c66ac9db 660 /* Pointer to transport specific device structure */
c66ac9db
NB
661 u32 dev_index;
662 u64 creation_time;
663 u32 num_resets;
664 u64 num_cmds;
665 u64 read_bytes;
666 u64 write_bytes;
667 spinlock_t stats_lock;
668 /* Active commands on this virtual SE device */
c66ac9db 669 atomic_t simple_cmds;
c66ac9db 670 atomic_t dev_ordered_id;
c66ac9db 671 atomic_t dev_ordered_sync;
07bde79a 672 atomic_t dev_qf_count;
0fd97ccf 673 int export_count;
c66ac9db 674 spinlock_t delayed_cmd_lock;
c66ac9db 675 spinlock_t execute_task_lock;
c66ac9db 676 spinlock_t dev_reservation_lock;
0fd97ccf
CH
677 unsigned int dev_reservation_flags;
678#define DRF_SPC2_RESERVATIONS 0x00000001
679#define DRF_SPC2_RESERVATIONS_WITH_ISID 0x00000002
c66ac9db
NB
680 spinlock_t se_port_lock;
681 spinlock_t se_tmr_lock;
07bde79a 682 spinlock_t qf_cmd_lock;
68ff9b9b 683 struct semaphore caw_sem;
c66ac9db
NB
684 /* Used for legacy SPC-2 reservationsa */
685 struct se_node_acl *dev_reserved_node_acl;
686 /* Used for ALUA Logical Unit Group membership */
687 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
688 /* Used for SPC-3 Persistent Reservations */
689 struct t10_pr_registration *dev_pr_res_holder;
690 struct list_head dev_sep_list;
691 struct list_head dev_tmr_list;
af877292 692 struct workqueue_struct *tmr_wq;
07bde79a 693 struct work_struct qf_work_queue;
c66ac9db 694 struct list_head delayed_cmd_list;
cf572a96 695 struct list_head state_list;
07bde79a 696 struct list_head qf_cmd_list;
d9ea32bf 697 struct list_head g_dev_node;
c66ac9db
NB
698 /* Pointer to associated SE HBA */
699 struct se_hba *se_hba;
0fd97ccf
CH
700 /* T10 Inquiry and VPD WWN Information */
701 struct t10_wwn t10_wwn;
702 /* T10 Asymmetric Logical Unit Assignment for Target Ports */
703 struct t10_alua t10_alua;
704 /* T10 SPC-2 + SPC-3 Reservations */
705 struct t10_reservation t10_pr;
706 struct se_dev_attrib dev_attrib;
707 struct config_group dev_group;
708 struct config_group dev_pr_group;
709 struct se_dev_stat_grps dev_stat_grps;
710#define SE_DEV_ALIAS_LEN 512 /* must be less than PAGE_SIZE */
711 unsigned char dev_alias[SE_DEV_ALIAS_LEN];
712#define SE_UDEV_PATH_LEN 512 /* must be less than PAGE_SIZE */
713 unsigned char udev_path[SE_UDEV_PATH_LEN];
c66ac9db
NB
714 /* Pointer to template of function pointers for transport */
715 struct se_subsystem_api *transport;
716 /* Linked list for struct se_hba struct se_device list */
717 struct list_head dev_list;
e0a53e70 718};
c66ac9db 719
c66ac9db
NB
720struct se_hba {
721 u16 hba_tpgt;
722 u32 hba_id;
723 /* See hba_flags_table */
724 u32 hba_flags;
725 /* Virtual iSCSI devices attached. */
726 u32 dev_count;
727 u32 hba_index;
c66ac9db
NB
728 /* Pointer to transport specific host structure. */
729 void *hba_ptr;
e3d6f909 730 struct list_head hba_node;
c66ac9db 731 spinlock_t device_lock;
c66ac9db
NB
732 struct config_group hba_group;
733 struct mutex hba_access_mutex;
734 struct se_subsystem_api *transport;
e0a53e70 735};
c66ac9db 736
12d23384
NB
737struct se_port_stat_grps {
738 struct config_group stat_group;
739 struct config_group scsi_port_group;
740 struct config_group scsi_tgt_port_group;
741 struct config_group scsi_transport_group;
742};
743
c66ac9db 744struct se_lun {
0ff87549
NB
745#define SE_LUN_LINK_MAGIC 0xffff7771
746 u32 lun_link_magic;
c66ac9db
NB
747 /* See transport_lun_status_table */
748 enum transport_lun_status_table lun_status;
749 u32 lun_access;
750 u32 lun_flags;
751 u32 unpacked_lun;
752 atomic_t lun_acl_count;
753 spinlock_t lun_acl_lock;
754 spinlock_t lun_cmd_lock;
755 spinlock_t lun_sep_lock;
756 struct completion lun_shutdown_comp;
757 struct list_head lun_cmd_list;
758 struct list_head lun_acl_list;
759 struct se_device *lun_se_dev;
12d23384 760 struct se_port *lun_sep;
c66ac9db 761 struct config_group lun_group;
12d23384 762 struct se_port_stat_grps port_stat_grps;
5277797d
NB
763 struct completion lun_ref_comp;
764 struct percpu_ref lun_ref;
e0a53e70 765};
c66ac9db 766
e89d15ee
NB
767struct scsi_port_stats {
768 u64 cmd_pdus;
769 u64 tx_data_octets;
770 u64 rx_data_octets;
e0a53e70 771};
e89d15ee 772
c66ac9db
NB
773struct se_port {
774 /* RELATIVE TARGET PORT IDENTIFER */
775 u16 sep_rtpi;
776 int sep_tg_pt_secondary_stat;
777 int sep_tg_pt_secondary_write_md;
778 u32 sep_index;
779 struct scsi_port_stats sep_stats;
780 /* Used for ALUA Target Port Groups membership */
c66ac9db
NB
781 atomic_t sep_tg_pt_secondary_offline;
782 /* Used for PR ALL_TG_PT=1 */
783 atomic_t sep_tg_pt_ref_cnt;
784 spinlock_t sep_alua_lock;
785 struct mutex sep_tg_pt_md_mutex;
786 struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
787 struct se_lun *sep_lun;
788 struct se_portal_group *sep_tpg;
789 struct list_head sep_alua_list;
790 struct list_head sep_list;
e0a53e70 791};
c66ac9db
NB
792
793struct se_tpg_np {
1f6fe7cb 794 struct se_portal_group *tpg_np_parent;
c66ac9db 795 struct config_group tpg_np_group;
e0a53e70 796};
c66ac9db
NB
797
798struct se_portal_group {
799 /* Type of target portal group, see transport_tpg_type_table */
800 enum transport_tpg_type_table se_tpg_type;
801 /* Number of ACLed Initiator Nodes for this TPG */
802 u32 num_node_acls;
803 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
804 atomic_t tpg_pr_ref_count;
805 /* Spinlock for adding/removing ACLed Nodes */
806 spinlock_t acl_node_lock;
807 /* Spinlock for adding/removing sessions */
808 spinlock_t session_lock;
809 spinlock_t tpg_lun_lock;
810 /* Pointer to $FABRIC_MOD portal group */
811 void *se_tpg_fabric_ptr;
e3d6f909 812 struct list_head se_tpg_node;
c66ac9db
NB
813 /* linked list for initiator ACL list */
814 struct list_head acl_node_list;
4a5a75f3 815 struct se_lun **tpg_lun_list;
c66ac9db 816 struct se_lun tpg_virt_lun0;
25985edc 817 /* List of TCM sessions associated wth this TPG */
c66ac9db
NB
818 struct list_head tpg_sess_list;
819 /* Pointer to $FABRIC_MOD dependent code */
820 struct target_core_fabric_ops *se_tpg_tfo;
821 struct se_wwn *se_tpg_wwn;
822 struct config_group tpg_group;
e4b512e7 823 struct config_group *tpg_default_groups[7];
c66ac9db
NB
824 struct config_group tpg_lun_group;
825 struct config_group tpg_np_group;
826 struct config_group tpg_acl_group;
827 struct config_group tpg_attrib_group;
e4b512e7 828 struct config_group tpg_auth_group;
c66ac9db 829 struct config_group tpg_param_group;
e0a53e70 830};
c66ac9db 831
c66ac9db
NB
832struct se_wwn {
833 struct target_fabric_configfs *wwn_tf;
834 struct config_group wwn_group;
12d23384
NB
835 struct config_group *wwn_default_groups[2];
836 struct config_group fabric_stat_group;
e0a53e70 837};
c66ac9db 838
c66ac9db 839#endif /* TARGET_CORE_BASE_H */