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