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