?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge tag 'iommu-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/arm64/linux
[linux/fpc-iii.git] / include / target / target_core_base.h
blob63dd12124139c3759827081fa33a40e671aa84f3
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 };
199
200 /* fabric independent task management function values */
201 enum tcm_tmreq_table {
202 TMR_ABORT_TASK = 1,
203 TMR_ABORT_TASK_SET = 2,
204 TMR_CLEAR_ACA = 3,
205 TMR_CLEAR_TASK_SET = 4,
206 TMR_LUN_RESET = 5,
207 TMR_TARGET_WARM_RESET = 6,
208 TMR_TARGET_COLD_RESET = 7,
209 TMR_LUN_RESET_PRO = 0x80,
210 TMR_UNKNOWN = 0xff,
211 };
212
213 /* fabric independent task management response values */
214 enum tcm_tmrsp_table {
215 TMR_FUNCTION_FAILED = 0,
216 TMR_FUNCTION_COMPLETE = 1,
217 TMR_TASK_DOES_NOT_EXIST = 2,
218 TMR_LUN_DOES_NOT_EXIST = 3,
219 TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED = 4,
220 TMR_FUNCTION_REJECTED = 5,
221 };
222
223 /*
224 * Used for target SCSI statistics
225 */
226 typedef enum {
227 SCSI_INST_INDEX,
228 SCSI_AUTH_INTR_INDEX,
229 SCSI_INDEX_TYPE_MAX
230 } scsi_index_t;
231
232 struct se_cmd;
233
234 struct t10_alua_lba_map_member {
235 struct list_head lba_map_mem_list;
236 int lba_map_mem_alua_state;
237 int lba_map_mem_alua_pg_id;
238 };
239
240 struct t10_alua_lba_map {
241 u64 lba_map_first_lba;
242 u64 lba_map_last_lba;
243 struct list_head lba_map_list;
244 struct list_head lba_map_mem_list;
245 };
246
247 struct t10_alua {
248 /* ALUA Target Port Group ID */
249 u16 alua_tg_pt_gps_counter;
250 u32 alua_tg_pt_gps_count;
251 /* Referrals support */
252 spinlock_t lba_map_lock;
253 u32 lba_map_segment_size;
254 u32 lba_map_segment_multiplier;
255 struct list_head lba_map_list;
256 spinlock_t tg_pt_gps_lock;
257 struct se_device *t10_dev;
258 /* Used for default ALUA Target Port Group */
259 struct t10_alua_tg_pt_gp *default_tg_pt_gp;
260 /* Used for default ALUA Target Port Group ConfigFS group */
261 struct config_group alua_tg_pt_gps_group;
262 struct list_head tg_pt_gps_list;
263 };
264
265 struct t10_alua_lu_gp {
266 u16 lu_gp_id;
267 int lu_gp_valid_id;
268 u32 lu_gp_members;
269 atomic_t lu_gp_ref_cnt;
270 spinlock_t lu_gp_lock;
271 struct config_group lu_gp_group;
272 struct list_head lu_gp_node;
273 struct list_head lu_gp_mem_list;
274 };
275
276 struct t10_alua_lu_gp_member {
277 bool lu_gp_assoc;
278 atomic_t lu_gp_mem_ref_cnt;
279 spinlock_t lu_gp_mem_lock;
280 struct t10_alua_lu_gp *lu_gp;
281 struct se_device *lu_gp_mem_dev;
282 struct list_head lu_gp_mem_list;
283 };
284
285 struct t10_alua_tg_pt_gp {
286 u16 tg_pt_gp_id;
287 int tg_pt_gp_valid_id;
288 int tg_pt_gp_alua_supported_states;
289 int tg_pt_gp_alua_access_status;
290 int tg_pt_gp_alua_access_type;
291 int tg_pt_gp_nonop_delay_msecs;
292 int tg_pt_gp_trans_delay_msecs;
293 int tg_pt_gp_implicit_trans_secs;
294 int tg_pt_gp_pref;
295 int tg_pt_gp_write_metadata;
296 u32 tg_pt_gp_members;
297 int tg_pt_gp_alua_access_state;
298 atomic_t tg_pt_gp_ref_cnt;
299 spinlock_t tg_pt_gp_lock;
300 struct mutex tg_pt_gp_transition_mutex;
301 struct se_device *tg_pt_gp_dev;
302 struct config_group tg_pt_gp_group;
303 struct list_head tg_pt_gp_list;
304 struct list_head tg_pt_gp_lun_list;
305 struct se_lun *tg_pt_gp_alua_lun;
306 struct se_node_acl *tg_pt_gp_alua_nacl;
307 };
308
309 struct t10_vpd {
310 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
311 int protocol_identifier_set;
312 u32 protocol_identifier;
313 u32 device_identifier_code_set;
314 u32 association;
315 u32 device_identifier_type;
316 struct list_head vpd_list;
317 };
318
319 struct t10_wwn {
320 /*
321 * SCSI left aligned strings may not be null terminated. +1 to ensure a
322 * null terminator is always present.
323 */
324 char vendor[INQUIRY_VENDOR_LEN + 1];
325 char model[INQUIRY_MODEL_LEN + 1];
326 char revision[INQUIRY_REVISION_LEN + 1];
327 char unit_serial[INQUIRY_VPD_SERIAL_LEN];
328 spinlock_t t10_vpd_lock;
329 struct se_device *t10_dev;
330 struct config_group t10_wwn_group;
331 struct list_head t10_vpd_list;
332 };
333
334 struct t10_pr_registration {
335 /* Used for fabrics that contain WWN+ISID */
336 #define PR_REG_ISID_LEN 16
337 /* PR_REG_ISID_LEN + ',i,0x' */
338 #define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
339 char pr_reg_isid[PR_REG_ISID_LEN];
340 /* Used during APTPL metadata reading */
341 #define PR_APTPL_MAX_IPORT_LEN 256
342 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
343 /* Used during APTPL metadata reading */
344 #define PR_APTPL_MAX_TPORT_LEN 256
345 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
346 u16 pr_aptpl_rpti;
347 u16 pr_reg_tpgt;
348 /* Reservation effects all target ports */
349 int pr_reg_all_tg_pt;
350 /* Activate Persistence across Target Power Loss */
351 int pr_reg_aptpl;
352 int pr_res_holder;
353 int pr_res_type;
354 int pr_res_scope;
355 /* Used for fabric initiator WWPNs using a ISID */
356 bool isid_present_at_reg;
357 u64 pr_res_mapped_lun;
358 u64 pr_aptpl_target_lun;
359 u16 tg_pt_sep_rtpi;
360 u32 pr_res_generation;
361 u64 pr_reg_bin_isid;
362 u64 pr_res_key;
363 atomic_t pr_res_holders;
364 struct se_node_acl *pr_reg_nacl;
365 /* Used by ALL_TG_PT=1 registration with deve->pr_ref taken */
366 struct se_dev_entry *pr_reg_deve;
367 struct list_head pr_reg_list;
368 struct list_head pr_reg_abort_list;
369 struct list_head pr_reg_aptpl_list;
370 struct list_head pr_reg_atp_list;
371 struct list_head pr_reg_atp_mem_list;
372 };
373
374 struct t10_reservation {
375 /* Reservation effects all target ports */
376 int pr_all_tg_pt;
377 /* Activate Persistence across Target Power Loss enabled
378 * for SCSI device */
379 int pr_aptpl_active;
380 #define PR_APTPL_BUF_LEN 262144
381 u32 pr_generation;
382 spinlock_t registration_lock;
383 spinlock_t aptpl_reg_lock;
384 /*
385 * This will always be set by one individual I_T Nexus.
386 * However with all_tg_pt=1, other I_T Nexus from the
387 * same initiator can access PR reg/res info on a different
388 * target port.
389 *
390 * There is also the 'All Registrants' case, where there is
391 * a single *pr_res_holder of the reservation, but all
392 * registrations are considered reservation holders.
393 */
394 struct se_node_acl *pr_res_holder;
395 struct list_head registration_list;
396 struct list_head aptpl_reg_list;
397 };
398
399 struct se_tmr_req {
400 /* Task Management function to be performed */
401 u8 function;
402 /* Task Management response to send */
403 u8 response;
404 int call_transport;
405 /* Reference to ITT that Task Mgmt should be performed */
406 u64 ref_task_tag;
407 void *fabric_tmr_ptr;
408 struct se_cmd *task_cmd;
409 struct se_device *tmr_dev;
410 struct list_head tmr_list;
411 };
412
413 enum target_prot_op {
414 TARGET_PROT_NORMAL = 0,
415 TARGET_PROT_DIN_INSERT = (1 << 0),
416 TARGET_PROT_DOUT_INSERT = (1 << 1),
417 TARGET_PROT_DIN_STRIP = (1 << 2),
418 TARGET_PROT_DOUT_STRIP = (1 << 3),
419 TARGET_PROT_DIN_PASS = (1 << 4),
420 TARGET_PROT_DOUT_PASS = (1 << 5),
421 };
422
423 #define TARGET_PROT_ALL TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \
424 TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \
425 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS
426
427 enum target_prot_type {
428 TARGET_DIF_TYPE0_PROT,
429 TARGET_DIF_TYPE1_PROT,
430 TARGET_DIF_TYPE2_PROT,
431 TARGET_DIF_TYPE3_PROT,
432 };
433
434 /* Emulation for UNIT ATTENTION Interlock Control */
435 enum target_ua_intlck_ctrl {
436 TARGET_UA_INTLCK_CTRL_CLEAR = 0,
437 TARGET_UA_INTLCK_CTRL_NO_CLEAR = 1,
438 TARGET_UA_INTLCK_CTRL_ESTABLISH_UA = 2,
439 };
440
441 enum target_core_dif_check {
442 TARGET_DIF_CHECK_GUARD = 0x1 << 0,
443 TARGET_DIF_CHECK_APPTAG = 0x1 << 1,
444 TARGET_DIF_CHECK_REFTAG = 0x1 << 2,
445 };
446
447 /* for sam_task_attr */
448 #define TCM_SIMPLE_TAG 0x20
449 #define TCM_HEAD_TAG 0x21
450 #define TCM_ORDERED_TAG 0x22
451 #define TCM_ACA_TAG 0x24
452
453 struct se_cmd {
454 /* SAM response code being sent to initiator */
455 u8 scsi_status;
456 u8 scsi_asc;
457 u8 scsi_ascq;
458 u16 scsi_sense_length;
459 unsigned unknown_data_length:1;
460 bool state_active:1;
461 u64 tag; /* SAM command identifier aka task tag */
462 /* Delay for ALUA Active/NonOptimized state access in milliseconds */
463 int alua_nonop_delay;
464 /* See include/linux/dma-mapping.h */
465 enum dma_data_direction data_direction;
466 /* For SAM Task Attribute */
467 int sam_task_attr;
468 /* Used for se_sess->sess_tag_pool */
469 unsigned int map_tag;
470 int map_cpu;
471 /* Transport protocol dependent state, see transport_state_table */
472 enum transport_state_table t_state;
473 /* See se_cmd_flags_table */
474 u32 se_cmd_flags;
475 /* Total size in bytes associated with command */
476 u32 data_length;
477 u32 residual_count;
478 u64 orig_fe_lun;
479 /* Persistent Reservation key */
480 u64 pr_res_key;
481 /* Used for sense data */
482 void *sense_buffer;
483 struct list_head se_delayed_node;
484 struct list_head se_qf_node;
485 struct se_device *se_dev;
486 struct se_lun *se_lun;
487 /* Only used for internal passthrough and legacy TCM fabric modules */
488 struct se_session *se_sess;
489 struct se_tmr_req *se_tmr_req;
490 struct list_head se_cmd_list;
491 struct completion *free_compl;
492 struct completion *abrt_compl;
493 const struct target_core_fabric_ops *se_tfo;
494 sense_reason_t (*execute_cmd)(struct se_cmd *);
495 sense_reason_t (*transport_complete_callback)(struct se_cmd *, bool, int *);
496 void *protocol_data;
497
498 unsigned char *t_task_cdb;
499 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
500 unsigned long long t_task_lba;
501 unsigned int t_task_nolb;
502 unsigned int transport_state;
503 #define CMD_T_ABORTED (1 << 0)
504 #define CMD_T_ACTIVE (1 << 1)
505 #define CMD_T_COMPLETE (1 << 2)
506 #define CMD_T_SENT (1 << 4)
507 #define CMD_T_STOP (1 << 5)
508 #define CMD_T_TAS (1 << 10)
509 #define CMD_T_FABRIC_STOP (1 << 11)
510 spinlock_t t_state_lock;
511 struct kref cmd_kref;
512 struct completion t_transport_stop_comp;
513
514 struct work_struct work;
515
516 struct scatterlist *t_data_sg;
517 struct scatterlist *t_data_sg_orig;
518 unsigned int t_data_nents;
519 unsigned int t_data_nents_orig;
520 void *t_data_vmap;
521 struct scatterlist *t_bidi_data_sg;
522 unsigned int t_bidi_data_nents;
523
524 /* Used for lun->lun_ref counting */
525 int lun_ref_active;
526
527 struct list_head state_list;
528
529 /* backend private data */
530 void *priv;
531
532 /* DIF related members */
533 enum target_prot_op prot_op;
534 enum target_prot_type prot_type;
535 u8 prot_checks;
536 bool prot_pto;
537 u32 prot_length;
538 u32 reftag_seed;
539 struct scatterlist *t_prot_sg;
540 unsigned int t_prot_nents;
541 sense_reason_t pi_err;
542 u64 sense_info;
543 /*
544 * CPU LIO will execute the cmd on. Defaults to the CPU the cmd is
545 * initialized on. Drivers can override.
546 */
547 int cpuid;
548 };
549
550 struct se_ua {
551 u8 ua_asc;
552 u8 ua_ascq;
553 struct list_head ua_nacl_list;
554 };
555
556 struct se_node_acl {
557 char initiatorname[TRANSPORT_IQN_LEN];
558 /* Used to signal demo mode created ACL, disabled by default */
559 bool dynamic_node_acl;
560 bool dynamic_stop;
561 u32 queue_depth;
562 u32 acl_index;
563 enum target_prot_type saved_prot_type;
564 #define MAX_ACL_TAG_SIZE 64
565 char acl_tag[MAX_ACL_TAG_SIZE];
566 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
567 atomic_t acl_pr_ref_count;
568 struct hlist_head lun_entry_hlist;
569 struct se_session *nacl_sess;
570 struct se_portal_group *se_tpg;
571 struct mutex lun_entry_mutex;
572 spinlock_t nacl_sess_lock;
573 struct config_group acl_group;
574 struct config_group acl_attrib_group;
575 struct config_group acl_auth_group;
576 struct config_group acl_param_group;
577 struct config_group acl_fabric_stat_group;
578 struct list_head acl_list;
579 struct list_head acl_sess_list;
580 struct completion acl_free_comp;
581 struct kref acl_kref;
582 };
583
584 static inline struct se_node_acl *acl_to_nacl(struct config_item *item)
585 {
586 return container_of(to_config_group(item), struct se_node_acl,
587 acl_group);
588 }
589
590 static inline struct se_node_acl *attrib_to_nacl(struct config_item *item)
591 {
592 return container_of(to_config_group(item), struct se_node_acl,
593 acl_attrib_group);
594 }
595
596 static inline struct se_node_acl *auth_to_nacl(struct config_item *item)
597 {
598 return container_of(to_config_group(item), struct se_node_acl,
599 acl_auth_group);
600 }
601
602 static inline struct se_node_acl *param_to_nacl(struct config_item *item)
603 {
604 return container_of(to_config_group(item), struct se_node_acl,
605 acl_param_group);
606 }
607
608 static inline struct se_node_acl *fabric_stat_to_nacl(struct config_item *item)
609 {
610 return container_of(to_config_group(item), struct se_node_acl,
611 acl_fabric_stat_group);
612 }
613
614 struct se_session {
615 atomic_t stopped;
616 u64 sess_bin_isid;
617 enum target_prot_op sup_prot_ops;
618 enum target_prot_type sess_prot_type;
619 struct se_node_acl *se_node_acl;
620 struct se_portal_group *se_tpg;
621 void *fabric_sess_ptr;
622 struct percpu_ref cmd_count;
623 struct list_head sess_list;
624 struct list_head sess_acl_list;
625 spinlock_t sess_cmd_lock;
626 wait_queue_head_t cmd_count_wq;
627 struct completion stop_done;
628 void *sess_cmd_map;
629 struct sbitmap_queue sess_tag_pool;
630 };
631
632 struct se_device;
633 struct se_transform_info;
634 struct scatterlist;
635
636 struct se_ml_stat_grps {
637 struct config_group stat_group;
638 struct config_group scsi_auth_intr_group;
639 struct config_group scsi_att_intr_port_group;
640 };
641
642 struct se_lun_acl {
643 u64 mapped_lun;
644 struct se_node_acl *se_lun_nacl;
645 struct se_lun *se_lun;
646 struct config_group se_lun_group;
647 struct se_ml_stat_grps ml_stat_grps;
648 };
649
650 struct se_dev_entry {
651 u64 mapped_lun;
652 u64 pr_res_key;
653 u64 creation_time;
654 bool lun_access_ro;
655 u32 attach_count;
656 atomic_long_t total_cmds;
657 atomic_long_t read_bytes;
658 atomic_long_t write_bytes;
659 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
660 struct kref pr_kref;
661 struct completion pr_comp;
662 struct se_lun_acl __rcu *se_lun_acl;
663 spinlock_t ua_lock;
664 struct se_lun __rcu *se_lun;
665 #define DEF_PR_REG_ACTIVE 1
666 unsigned long deve_flags;
667 struct list_head alua_port_list;
668 struct list_head lun_link;
669 struct list_head ua_list;
670 struct hlist_node link;
671 struct rcu_head rcu_head;
672 };
673
674 struct se_dev_attrib {
675 bool emulate_model_alias;
676 bool emulate_dpo; /* deprecated */
677 bool emulate_fua_write;
678 bool emulate_fua_read; /* deprecated */
679 bool emulate_write_cache;
680 enum target_ua_intlck_ctrl emulate_ua_intlck_ctrl;
681 bool emulate_tas;
682 bool emulate_tpu;
683 bool emulate_tpws;
684 bool emulate_caw;
685 bool emulate_3pc;
686 bool emulate_pr;
687 enum target_prot_type pi_prot_type;
688 enum target_prot_type hw_pi_prot_type;
689 bool pi_prot_verify;
690 bool enforce_pr_isids;
691 bool force_pr_aptpl;
692 bool is_nonrot;
693 bool emulate_rest_reord;
694 bool unmap_zeroes_data;
695 u32 hw_block_size;
696 u32 block_size;
697 u32 hw_max_sectors;
698 u32 optimal_sectors;
699 u32 hw_queue_depth;
700 u32 queue_depth;
701 u32 max_unmap_lba_count;
702 u32 max_unmap_block_desc_count;
703 u32 unmap_granularity;
704 u32 unmap_granularity_alignment;
705 u32 max_write_same_len;
706 u32 max_bytes_per_io;
707 struct se_device *da_dev;
708 struct config_group da_group;
709 };
710
711 struct se_port_stat_grps {
712 struct config_group stat_group;
713 struct config_group scsi_port_group;
714 struct config_group scsi_tgt_port_group;
715 struct config_group scsi_transport_group;
716 };
717
718 struct scsi_port_stats {
719 atomic_long_t cmd_pdus;
720 atomic_long_t tx_data_octets;
721 atomic_long_t rx_data_octets;
722 };
723
724 struct se_lun {
725 u64 unpacked_lun;
726 bool lun_shutdown;
727 bool lun_access_ro;
728 u32 lun_index;
729
730 /* RELATIVE TARGET PORT IDENTIFER */
731 u16 lun_rtpi;
732 atomic_t lun_acl_count;
733 struct se_device __rcu *lun_se_dev;
734
735 struct list_head lun_deve_list;
736 spinlock_t lun_deve_lock;
737
738 /* ALUA state */
739 int lun_tg_pt_secondary_stat;
740 int lun_tg_pt_secondary_write_md;
741 atomic_t lun_tg_pt_secondary_offline;
742 struct mutex lun_tg_pt_md_mutex;
743
744 /* ALUA target port group linkage */
745 struct list_head lun_tg_pt_gp_link;
746 struct t10_alua_tg_pt_gp *lun_tg_pt_gp;
747 spinlock_t lun_tg_pt_gp_lock;
748
749 struct se_portal_group *lun_tpg;
750 struct scsi_port_stats lun_stats;
751 struct config_group lun_group;
752 struct se_port_stat_grps port_stat_grps;
753 struct completion lun_shutdown_comp;
754 struct percpu_ref lun_ref;
755 struct list_head lun_dev_link;
756 struct hlist_node link;
757 struct rcu_head rcu_head;
758 };
759
760 struct se_dev_stat_grps {
761 struct config_group stat_group;
762 struct config_group scsi_dev_group;
763 struct config_group scsi_tgt_dev_group;
764 struct config_group scsi_lu_group;
765 };
766
767 struct se_device_queue {
768 struct list_head state_list;
769 spinlock_t lock;
770 };
771
772 struct se_device {
773 /* RELATIVE TARGET PORT IDENTIFER Counter */
774 u16 dev_rpti_counter;
775 /* Used for SAM Task Attribute ordering */
776 u32 dev_cur_ordered_id;
777 u32 dev_flags;
778 #define DF_CONFIGURED 0x00000001
779 #define DF_FIRMWARE_VPD_UNIT_SERIAL 0x00000002
780 #define DF_EMULATED_VPD_UNIT_SERIAL 0x00000004
781 #define DF_USING_UDEV_PATH 0x00000008
782 #define DF_USING_ALIAS 0x00000010
783 #define DF_READ_ONLY 0x00000020
784 u8 transport_flags;
785 /* Physical device queue depth */
786 u32 queue_depth;
787 /* Used for SPC-2 reservations enforce of ISIDs */
788 u64 dev_res_bin_isid;
789 /* Pointer to transport specific device structure */
790 u32 dev_index;
791 u64 creation_time;
792 atomic_long_t num_resets;
793 atomic_long_t aborts_complete;
794 atomic_long_t aborts_no_task;
795 atomic_long_t num_cmds;
796 atomic_long_t read_bytes;
797 atomic_long_t write_bytes;
798 /* Active commands on this virtual SE device */
799 atomic_t simple_cmds;
800 atomic_t dev_ordered_sync;
801 atomic_t dev_qf_count;
802 u32 export_count;
803 spinlock_t delayed_cmd_lock;
804 spinlock_t dev_reservation_lock;
805 unsigned int dev_reservation_flags;
806 #define DRF_SPC2_RESERVATIONS 0x00000001
807 #define DRF_SPC2_RESERVATIONS_WITH_ISID 0x00000002
808 spinlock_t se_port_lock;
809 spinlock_t se_tmr_lock;
810 spinlock_t qf_cmd_lock;
811 struct semaphore caw_sem;
812 /* Used for legacy SPC-2 reservations */
813 struct se_session *reservation_holder;
814 /* Used for ALUA Logical Unit Group membership */
815 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
816 /* Used for SPC-3 Persistent Reservations */
817 struct t10_pr_registration *dev_pr_res_holder;
818 struct list_head dev_sep_list;
819 struct list_head dev_tmr_list;
820 struct work_struct qf_work_queue;
821 struct list_head delayed_cmd_list;
822 struct list_head qf_cmd_list;
823 /* Pointer to associated SE HBA */
824 struct se_hba *se_hba;
825 /* T10 Inquiry and VPD WWN Information */
826 struct t10_wwn t10_wwn;
827 /* T10 Asymmetric Logical Unit Assignment for Target Ports */
828 struct t10_alua t10_alua;
829 /* T10 SPC-2 + SPC-3 Reservations */
830 struct t10_reservation t10_pr;
831 struct se_dev_attrib dev_attrib;
832 struct config_group dev_action_group;
833 struct config_group dev_group;
834 struct config_group dev_pr_group;
835 struct se_dev_stat_grps dev_stat_grps;
836 #define SE_DEV_ALIAS_LEN 512 /* must be less than PAGE_SIZE */
837 unsigned char dev_alias[SE_DEV_ALIAS_LEN];
838 #define SE_UDEV_PATH_LEN 512 /* must be less than PAGE_SIZE */
839 unsigned char udev_path[SE_UDEV_PATH_LEN];
840 /* Pointer to template of function pointers for transport */
841 const struct target_backend_ops *transport;
842 struct se_lun xcopy_lun;
843 /* Protection Information */
844 int prot_length;
845 /* For se_lun->lun_se_dev RCU read-side critical access */
846 u32 hba_index;
847 struct rcu_head rcu_head;
848 int queue_cnt;
849 struct se_device_queue *queues;
850 };
851
852 struct se_hba {
853 u16 hba_tpgt;
854 u32 hba_id;
855 /* See hba_flags_table */
856 u32 hba_flags;
857 /* Virtual iSCSI devices attached. */
858 u32 dev_count;
859 u32 hba_index;
860 /* Pointer to transport specific host structure. */
861 void *hba_ptr;
862 struct list_head hba_node;
863 spinlock_t device_lock;
864 struct config_group hba_group;
865 struct mutex hba_access_mutex;
866 struct target_backend *backend;
867 };
868
869 struct se_tpg_np {
870 struct se_portal_group *tpg_np_parent;
871 struct config_group tpg_np_group;
872 };
873
874 static inline struct se_tpg_np *to_tpg_np(struct config_item *item)
875 {
876 return container_of(to_config_group(item), struct se_tpg_np,
877 tpg_np_group);
878 }
879
880 struct se_portal_group {
881 /*
882 * PROTOCOL IDENTIFIER value per SPC4, 7.5.1.
883 *
884 * Negative values can be used by fabric drivers for internal use TPGs.
885 */
886 int proto_id;
887 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
888 atomic_t tpg_pr_ref_count;
889 /* Spinlock for adding/removing ACLed Nodes */
890 struct mutex acl_node_mutex;
891 /* Spinlock for adding/removing sessions */
892 spinlock_t session_lock;
893 struct mutex tpg_lun_mutex;
894 /* linked list for initiator ACL list */
895 struct list_head acl_node_list;
896 struct hlist_head tpg_lun_hlist;
897 struct se_lun *tpg_virt_lun0;
898 /* List of TCM sessions associated wth this TPG */
899 struct list_head tpg_sess_list;
900 /* Pointer to $FABRIC_MOD dependent code */
901 const struct target_core_fabric_ops *se_tpg_tfo;
902 struct se_wwn *se_tpg_wwn;
903 struct config_group tpg_group;
904 struct config_group tpg_lun_group;
905 struct config_group tpg_np_group;
906 struct config_group tpg_acl_group;
907 struct config_group tpg_attrib_group;
908 struct config_group tpg_auth_group;
909 struct config_group tpg_param_group;
910 };
911
912 static inline struct se_portal_group *to_tpg(struct config_item *item)
913 {
914 return container_of(to_config_group(item), struct se_portal_group,
915 tpg_group);
916 }
917
918 static inline struct se_portal_group *attrib_to_tpg(struct config_item *item)
919 {
920 return container_of(to_config_group(item), struct se_portal_group,
921 tpg_attrib_group);
922 }
923
924 static inline struct se_portal_group *auth_to_tpg(struct config_item *item)
925 {
926 return container_of(to_config_group(item), struct se_portal_group,
927 tpg_auth_group);
928 }
929
930 static inline struct se_portal_group *param_to_tpg(struct config_item *item)
931 {
932 return container_of(to_config_group(item), struct se_portal_group,
933 tpg_param_group);
934 }
935
936 struct se_wwn {
937 struct target_fabric_configfs *wwn_tf;
938 void *priv;
939 struct config_group wwn_group;
940 struct config_group fabric_stat_group;
941 };
942
943 static inline void atomic_inc_mb(atomic_t *v)
944 {
945 smp_mb__before_atomic();
946 atomic_inc(v);
947 smp_mb__after_atomic();
948 }
949
950 static inline void atomic_dec_mb(atomic_t *v)
951 {
952 smp_mb__before_atomic();
953 atomic_dec(v);
954 smp_mb__after_atomic();
955 }
956
957 static inline void target_free_tag(struct se_session *sess, struct se_cmd *cmd)
958 {
959 sbitmap_queue_clear(&sess->sess_tag_pool, cmd->map_tag, cmd->map_cpu);
960 }
961
962 #endif /* TARGET_CORE_BASE_H */
Linux with added FPC-III support