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