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