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