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