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