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