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