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