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