?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge tag 'v3.3.7' into 3.3/master
[zen-stable.git] / include / target / target_core_base.h
blobfe73eb87a5620aea52d6fde972863fa4901d54aa
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 <scsi/scsi_cmnd.h>
9 #include <net/sock.h>
10 #include <net/tcp.h>
11
12 #define TARGET_CORE_MOD_VERSION "v4.1.0-rc1-ml"
13 #define TARGET_CORE_VERSION TARGET_CORE_MOD_VERSION
14
15 /* Maximum Number of LUNs per Target Portal Group */
16 /* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
17 #define TRANSPORT_MAX_LUNS_PER_TPG 256
18 /*
19 * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
20 *
21 * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
22 * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
23 * 16-byte CDBs by default and require an extra allocation for
24 * 32-byte CDBs to because of legacy issues.
25 *
26 * Within TCM Core there are no such legacy limitiations, so we go ahead
27 * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
28 * within all TCM Core and subsystem plugin code.
29 */
30 #define TCM_MAX_COMMAND_SIZE 32
31 /*
32 * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
33 * defined 96, but the real limit is 252 (or 260 including the header)
34 */
35 #define TRANSPORT_SENSE_BUFFER SCSI_SENSE_BUFFERSIZE
36 /* Used by transport_send_check_condition_and_sense() */
37 #define SPC_SENSE_KEY_OFFSET 2
38 #define SPC_ADD_SENSE_LEN_OFFSET 7
39 #define SPC_ASC_KEY_OFFSET 12
40 #define SPC_ASCQ_KEY_OFFSET 13
41 #define TRANSPORT_IQN_LEN 224
42 /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
43 #define LU_GROUP_NAME_BUF 256
44 /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
45 #define TG_PT_GROUP_NAME_BUF 256
46 /* Used to parse VPD into struct t10_vpd */
47 #define VPD_TMP_BUF_SIZE 128
48 /* Used by transport_generic_cmd_sequencer() */
49 #define READ_BLOCK_LEN 6
50 #define READ_CAP_LEN 8
51 #define READ_POSITION_LEN 20
52 #define INQUIRY_LEN 36
53 /* Used by transport_get_inquiry_vpd_serial() */
54 #define INQUIRY_VPD_SERIAL_LEN 254
55 /* Used by transport_get_inquiry_vpd_device_ident() */
56 #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN 254
57
58 /* Attempts before moving from SHORT to LONG */
59 #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD 3
60 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT 3 /* In milliseconds */
61 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG 10 /* In milliseconds */
62
63 #define PYX_TRANSPORT_STATUS_INTERVAL 5 /* In seconds */
64
65 /*
66 * struct se_subsystem_dev->su_dev_flags
67 */
68 #define SDF_FIRMWARE_VPD_UNIT_SERIAL 0x00000001
69 #define SDF_EMULATED_VPD_UNIT_SERIAL 0x00000002
70 #define SDF_USING_UDEV_PATH 0x00000004
71 #define SDF_USING_ALIAS 0x00000008
72
73 /*
74 * struct se_device->dev_flags
75 */
76 #define DF_READ_ONLY 0x00000001
77 #define DF_SPC2_RESERVATIONS 0x00000002
78 #define DF_SPC2_RESERVATIONS_WITH_ISID 0x00000004
79
80 /* struct se_dev_attrib sanity values */
81 /* Default max_unmap_lba_count */
82 #define DA_MAX_UNMAP_LBA_COUNT 0
83 /* Default max_unmap_block_desc_count */
84 #define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0
85 /* Default unmap_granularity */
86 #define DA_UNMAP_GRANULARITY_DEFAULT 0
87 /* Default unmap_granularity_alignment */
88 #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0
89 /* Emulation for Direct Page Out */
90 #define DA_EMULATE_DPO 0
91 /* Emulation for Forced Unit Access WRITEs */
92 #define DA_EMULATE_FUA_WRITE 1
93 /* Emulation for Forced Unit Access READs */
94 #define DA_EMULATE_FUA_READ 0
95 /* Emulation for WriteCache and SYNCHRONIZE_CACHE */
96 #define DA_EMULATE_WRITE_CACHE 0
97 /* Emulation for UNIT ATTENTION Interlock Control */
98 #define DA_EMULATE_UA_INTLLCK_CTRL 0
99 /* Emulation for TASK_ABORTED status (TAS) by default */
100 #define DA_EMULATE_TAS 1
101 /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
102 #define DA_EMULATE_TPU 0
103 /*
104 * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
105 * block/blk-lib.c:blkdev_issue_discard()
106 */
107 #define DA_EMULATE_TPWS 0
108 /* No Emulation for PSCSI by default */
109 #define DA_EMULATE_RESERVATIONS 0
110 /* No Emulation for PSCSI by default */
111 #define DA_EMULATE_ALUA 0
112 /* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
113 #define DA_ENFORCE_PR_ISIDS 1
114 #define DA_STATUS_MAX_SECTORS_MIN 16
115 #define DA_STATUS_MAX_SECTORS_MAX 8192
116 /* By default don't report non-rotating (solid state) medium */
117 #define DA_IS_NONROT 0
118 /* Queue Algorithm Modifier default for restricted reordering in control mode page */
119 #define DA_EMULATE_REST_REORD 0
120
121 #define SE_INQUIRY_BUF 512
122 #define SE_MODE_PAGE_BUF 512
123
124 /* struct se_hba->hba_flags */
125 enum hba_flags_table {
126 HBA_FLAGS_INTERNAL_USE = 0x01,
127 HBA_FLAGS_PSCSI_MODE = 0x02,
128 };
129
130 /* struct se_lun->lun_status */
131 enum transport_lun_status_table {
132 TRANSPORT_LUN_STATUS_FREE = 0,
133 TRANSPORT_LUN_STATUS_ACTIVE = 1,
134 };
135
136 /* struct se_portal_group->se_tpg_type */
137 enum transport_tpg_type_table {
138 TRANSPORT_TPG_TYPE_NORMAL = 0,
139 TRANSPORT_TPG_TYPE_DISCOVERY = 1,
140 };
141
142 /* struct se_task->task_flags */
143 enum se_task_flags {
144 TF_ACTIVE = (1 << 0),
145 TF_SENT = (1 << 1),
146 TF_REQUEST_STOP = (1 << 2),
147 TF_HAS_SENSE = (1 << 3),
148 };
149
150 /* Special transport agnostic struct se_cmd->t_states */
151 enum transport_state_table {
152 TRANSPORT_NO_STATE = 0,
153 TRANSPORT_NEW_CMD = 1,
154 TRANSPORT_WRITE_PENDING = 3,
155 TRANSPORT_PROCESS_WRITE = 4,
156 TRANSPORT_PROCESSING = 5,
157 TRANSPORT_COMPLETE = 6,
158 TRANSPORT_PROCESS_TMR = 9,
159 TRANSPORT_ISTATE_PROCESSING = 11,
160 TRANSPORT_NEW_CMD_MAP = 16,
161 TRANSPORT_COMPLETE_QF_WP = 18,
162 TRANSPORT_COMPLETE_QF_OK = 19,
163 };
164
165 /* Used for struct se_cmd->se_cmd_flags */
166 enum se_cmd_flags_table {
167 SCF_SUPPORTED_SAM_OPCODE = 0x00000001,
168 SCF_TRANSPORT_TASK_SENSE = 0x00000002,
169 SCF_EMULATED_TASK_SENSE = 0x00000004,
170 SCF_SCSI_DATA_SG_IO_CDB = 0x00000008,
171 SCF_SCSI_CONTROL_SG_IO_CDB = 0x00000010,
172 SCF_SCSI_NON_DATA_CDB = 0x00000040,
173 SCF_SCSI_CDB_EXCEPTION = 0x00000080,
174 SCF_SCSI_RESERVATION_CONFLICT = 0x00000100,
175 SCF_FUA = 0x00000200,
176 SCF_SE_LUN_CMD = 0x00000800,
177 SCF_SE_ALLOW_EOO = 0x00001000,
178 SCF_BIDI = 0x00002000,
179 SCF_SENT_CHECK_CONDITION = 0x00004000,
180 SCF_OVERFLOW_BIT = 0x00008000,
181 SCF_UNDERFLOW_BIT = 0x00010000,
182 SCF_SENT_DELAYED_TAS = 0x00020000,
183 SCF_ALUA_NON_OPTIMIZED = 0x00040000,
184 SCF_DELAYED_CMD_FROM_SAM_ATTR = 0x00080000,
185 SCF_UNUSED = 0x00100000,
186 SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00400000,
187 };
188
189 /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
190 enum transport_lunflags_table {
191 TRANSPORT_LUNFLAGS_NO_ACCESS = 0x00,
192 TRANSPORT_LUNFLAGS_INITIATOR_ACCESS = 0x01,
193 TRANSPORT_LUNFLAGS_READ_ONLY = 0x02,
194 TRANSPORT_LUNFLAGS_READ_WRITE = 0x04,
195 };
196
197 /* struct se_device->dev_status */
198 enum transport_device_status_table {
199 TRANSPORT_DEVICE_ACTIVATED = 0x01,
200 TRANSPORT_DEVICE_DEACTIVATED = 0x02,
201 TRANSPORT_DEVICE_QUEUE_FULL = 0x04,
202 TRANSPORT_DEVICE_SHUTDOWN = 0x08,
203 TRANSPORT_DEVICE_OFFLINE_ACTIVATED = 0x10,
204 TRANSPORT_DEVICE_OFFLINE_DEACTIVATED = 0x20,
205 };
206
207 /*
208 * Used by transport_send_check_condition_and_sense() and se_cmd->scsi_sense_reason
209 * to signal which ASC/ASCQ sense payload should be built.
210 */
211 enum tcm_sense_reason_table {
212 TCM_NON_EXISTENT_LUN = 0x01,
213 TCM_UNSUPPORTED_SCSI_OPCODE = 0x02,
214 TCM_INCORRECT_AMOUNT_OF_DATA = 0x03,
215 TCM_UNEXPECTED_UNSOLICITED_DATA = 0x04,
216 TCM_SERVICE_CRC_ERROR = 0x05,
217 TCM_SNACK_REJECTED = 0x06,
218 TCM_SECTOR_COUNT_TOO_MANY = 0x07,
219 TCM_INVALID_CDB_FIELD = 0x08,
220 TCM_INVALID_PARAMETER_LIST = 0x09,
221 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = 0x0a,
222 TCM_UNKNOWN_MODE_PAGE = 0x0b,
223 TCM_WRITE_PROTECTED = 0x0c,
224 TCM_CHECK_CONDITION_ABORT_CMD = 0x0d,
225 TCM_CHECK_CONDITION_UNIT_ATTENTION = 0x0e,
226 TCM_CHECK_CONDITION_NOT_READY = 0x0f,
227 TCM_RESERVATION_CONFLICT = 0x10,
228 };
229
230 enum target_sc_flags_table {
231 TARGET_SCF_BIDI_OP = 0x01,
232 TARGET_SCF_ACK_KREF = 0x02,
233 };
234
235 /* fabric independent task management function values */
236 enum tcm_tmreq_table {
237 TMR_ABORT_TASK = 1,
238 TMR_ABORT_TASK_SET = 2,
239 TMR_CLEAR_ACA = 3,
240 TMR_CLEAR_TASK_SET = 4,
241 TMR_LUN_RESET = 5,
242 TMR_TARGET_WARM_RESET = 6,
243 TMR_TARGET_COLD_RESET = 7,
244 TMR_FABRIC_TMR = 255,
245 };
246
247 /* fabric independent task management response values */
248 enum tcm_tmrsp_table {
249 TMR_FUNCTION_COMPLETE = 0,
250 TMR_TASK_DOES_NOT_EXIST = 1,
251 TMR_LUN_DOES_NOT_EXIST = 2,
252 TMR_TASK_STILL_ALLEGIANT = 3,
253 TMR_TASK_FAILOVER_NOT_SUPPORTED = 4,
254 TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED = 5,
255 TMR_FUNCTION_AUTHORIZATION_FAILED = 6,
256 TMR_FUNCTION_REJECTED = 255,
257 };
258
259 struct se_obj {
260 atomic_t obj_access_count;
261 };
262
263 /*
264 * Used by TCM Core internally to signal if ALUA emulation is enabled or
265 * disabled, or running in with TCM/pSCSI passthrough mode
266 */
267 typedef enum {
268 SPC_ALUA_PASSTHROUGH,
269 SPC2_ALUA_DISABLED,
270 SPC3_ALUA_EMULATED
271 } t10_alua_index_t;
272
273 /*
274 * Used by TCM Core internally to signal if SAM Task Attribute emulation
275 * is enabled or disabled, or running in with TCM/pSCSI passthrough mode
276 */
277 typedef enum {
278 SAM_TASK_ATTR_PASSTHROUGH,
279 SAM_TASK_ATTR_UNTAGGED,
280 SAM_TASK_ATTR_EMULATED
281 } t10_task_attr_index_t;
282
283 /*
284 * Used for target SCSI statistics
285 */
286 typedef enum {
287 SCSI_INST_INDEX,
288 SCSI_DEVICE_INDEX,
289 SCSI_AUTH_INTR_INDEX,
290 SCSI_INDEX_TYPE_MAX
291 } scsi_index_t;
292
293 struct se_cmd;
294
295 struct t10_alua {
296 t10_alua_index_t alua_type;
297 /* ALUA Target Port Group ID */
298 u16 alua_tg_pt_gps_counter;
299 u32 alua_tg_pt_gps_count;
300 spinlock_t tg_pt_gps_lock;
301 struct se_subsystem_dev *t10_sub_dev;
302 /* Used for default ALUA Target Port Group */
303 struct t10_alua_tg_pt_gp *default_tg_pt_gp;
304 /* Used for default ALUA Target Port Group ConfigFS group */
305 struct config_group alua_tg_pt_gps_group;
306 int (*alua_state_check)(struct se_cmd *, unsigned char *, u8 *);
307 struct list_head tg_pt_gps_list;
308 };
309
310 struct t10_alua_lu_gp {
311 u16 lu_gp_id;
312 int lu_gp_valid_id;
313 u32 lu_gp_members;
314 atomic_t lu_gp_ref_cnt;
315 spinlock_t lu_gp_lock;
316 struct config_group lu_gp_group;
317 struct list_head lu_gp_node;
318 struct list_head lu_gp_mem_list;
319 };
320
321 struct t10_alua_lu_gp_member {
322 bool lu_gp_assoc;
323 atomic_t lu_gp_mem_ref_cnt;
324 spinlock_t lu_gp_mem_lock;
325 struct t10_alua_lu_gp *lu_gp;
326 struct se_device *lu_gp_mem_dev;
327 struct list_head lu_gp_mem_list;
328 };
329
330 struct t10_alua_tg_pt_gp {
331 u16 tg_pt_gp_id;
332 int tg_pt_gp_valid_id;
333 int tg_pt_gp_alua_access_status;
334 int tg_pt_gp_alua_access_type;
335 int tg_pt_gp_nonop_delay_msecs;
336 int tg_pt_gp_trans_delay_msecs;
337 int tg_pt_gp_pref;
338 int tg_pt_gp_write_metadata;
339 /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
340 #define ALUA_MD_BUF_LEN 1024
341 u32 tg_pt_gp_md_buf_len;
342 u32 tg_pt_gp_members;
343 atomic_t tg_pt_gp_alua_access_state;
344 atomic_t tg_pt_gp_ref_cnt;
345 spinlock_t tg_pt_gp_lock;
346 struct mutex tg_pt_gp_md_mutex;
347 struct se_subsystem_dev *tg_pt_gp_su_dev;
348 struct config_group tg_pt_gp_group;
349 struct list_head tg_pt_gp_list;
350 struct list_head tg_pt_gp_mem_list;
351 };
352
353 struct t10_alua_tg_pt_gp_member {
354 bool tg_pt_gp_assoc;
355 atomic_t tg_pt_gp_mem_ref_cnt;
356 spinlock_t tg_pt_gp_mem_lock;
357 struct t10_alua_tg_pt_gp *tg_pt_gp;
358 struct se_port *tg_pt;
359 struct list_head tg_pt_gp_mem_list;
360 };
361
362 struct t10_vpd {
363 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
364 int protocol_identifier_set;
365 u32 protocol_identifier;
366 u32 device_identifier_code_set;
367 u32 association;
368 u32 device_identifier_type;
369 struct list_head vpd_list;
370 };
371
372 struct t10_wwn {
373 char vendor[8];
374 char model[16];
375 char revision[4];
376 char unit_serial[INQUIRY_VPD_SERIAL_LEN];
377 spinlock_t t10_vpd_lock;
378 struct se_subsystem_dev *t10_sub_dev;
379 struct config_group t10_wwn_group;
380 struct list_head t10_vpd_list;
381 };
382
383
384 /*
385 * Used by TCM Core internally to signal if >= SPC-3 persistent reservations
386 * emulation is enabled or disabled, or running in with TCM/pSCSI passthrough
387 * mode
388 */
389 typedef enum {
390 SPC_PASSTHROUGH,
391 SPC2_RESERVATIONS,
392 SPC3_PERSISTENT_RESERVATIONS
393 } t10_reservations_index_t;
394
395 struct t10_pr_registration {
396 /* Used for fabrics that contain WWN+ISID */
397 #define PR_REG_ISID_LEN 16
398 /* PR_REG_ISID_LEN + ',i,0x' */
399 #define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5)
400 char pr_reg_isid[PR_REG_ISID_LEN];
401 /* Used during APTPL metadata reading */
402 #define PR_APTPL_MAX_IPORT_LEN 256
403 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
404 /* Used during APTPL metadata reading */
405 #define PR_APTPL_MAX_TPORT_LEN 256
406 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
407 /* For writing out live meta data */
408 unsigned char *pr_aptpl_buf;
409 u16 pr_aptpl_rpti;
410 u16 pr_reg_tpgt;
411 /* Reservation effects all target ports */
412 int pr_reg_all_tg_pt;
413 /* Activate Persistence across Target Power Loss */
414 int pr_reg_aptpl;
415 int pr_res_holder;
416 int pr_res_type;
417 int pr_res_scope;
418 /* Used for fabric initiator WWPNs using a ISID */
419 bool isid_present_at_reg;
420 u32 pr_res_mapped_lun;
421 u32 pr_aptpl_target_lun;
422 u32 pr_res_generation;
423 u64 pr_reg_bin_isid;
424 u64 pr_res_key;
425 atomic_t pr_res_holders;
426 struct se_node_acl *pr_reg_nacl;
427 struct se_dev_entry *pr_reg_deve;
428 struct se_lun *pr_reg_tg_pt_lun;
429 struct list_head pr_reg_list;
430 struct list_head pr_reg_abort_list;
431 struct list_head pr_reg_aptpl_list;
432 struct list_head pr_reg_atp_list;
433 struct list_head pr_reg_atp_mem_list;
434 };
435
436 /*
437 * This set of function pointer ops is set based upon SPC3_PERSISTENT_RESERVATIONS,
438 * SPC2_RESERVATIONS or SPC_PASSTHROUGH in drivers/target/target_core_pr.c:
439 * core_setup_reservations()
440 */
441 struct t10_reservation_ops {
442 int (*t10_reservation_check)(struct se_cmd *, u32 *);
443 int (*t10_seq_non_holder)(struct se_cmd *, unsigned char *, u32);
444 int (*t10_pr_register)(struct se_cmd *);
445 int (*t10_pr_clear)(struct se_cmd *);
446 };
447
448 struct t10_reservation {
449 /* Reservation effects all target ports */
450 int pr_all_tg_pt;
451 /* Activate Persistence across Target Power Loss enabled
452 * for SCSI device */
453 int pr_aptpl_active;
454 /* Used by struct t10_reservation->pr_aptpl_buf_len */
455 #define PR_APTPL_BUF_LEN 8192
456 u32 pr_aptpl_buf_len;
457 u32 pr_generation;
458 t10_reservations_index_t res_type;
459 spinlock_t registration_lock;
460 spinlock_t aptpl_reg_lock;
461 /*
462 * This will always be set by one individual I_T Nexus.
463 * However with all_tg_pt=1, other I_T Nexus from the
464 * same initiator can access PR reg/res info on a different
465 * target port.
466 *
467 * There is also the 'All Registrants' case, where there is
468 * a single *pr_res_holder of the reservation, but all
469 * registrations are considered reservation holders.
470 */
471 struct se_node_acl *pr_res_holder;
472 struct list_head registration_list;
473 struct list_head aptpl_reg_list;
474 struct t10_reservation_ops pr_ops;
475 };
476
477 struct se_queue_req {
478 int state;
479 struct se_cmd *cmd;
480 struct list_head qr_list;
481 };
482
483 struct se_queue_obj {
484 atomic_t queue_cnt;
485 spinlock_t cmd_queue_lock;
486 struct list_head qobj_list;
487 wait_queue_head_t thread_wq;
488 };
489
490 struct se_task {
491 unsigned long long task_lba;
492 u32 task_sectors;
493 u32 task_size;
494 struct se_cmd *task_se_cmd;
495 struct scatterlist *task_sg;
496 u32 task_sg_nents;
497 u16 task_flags;
498 u8 task_scsi_status;
499 enum dma_data_direction task_data_direction;
500 struct list_head t_list;
501 struct list_head t_execute_list;
502 struct list_head t_state_list;
503 bool t_state_active;
504 struct completion task_stop_comp;
505 };
506
507 struct se_cmd {
508 /* SAM response code being sent to initiator */
509 u8 scsi_status;
510 u8 scsi_asc;
511 u8 scsi_ascq;
512 u8 scsi_sense_reason;
513 u16 scsi_sense_length;
514 /* Delay for ALUA Active/NonOptimized state access in milliseconds */
515 int alua_nonop_delay;
516 /* See include/linux/dma-mapping.h */
517 enum dma_data_direction data_direction;
518 /* For SAM Task Attribute */
519 int sam_task_attr;
520 /* Transport protocol dependent state, see transport_state_table */
521 enum transport_state_table t_state;
522 /* Used to signal cmd->se_tfo->check_release_cmd() usage per cmd */
523 unsigned check_release:1;
524 unsigned cmd_wait_set:1;
525 /* See se_cmd_flags_table */
526 u32 se_cmd_flags;
527 u32 se_ordered_id;
528 /* Total size in bytes associated with command */
529 u32 data_length;
530 /* SCSI Presented Data Transfer Length */
531 u32 cmd_spdtl;
532 u32 residual_count;
533 u32 orig_fe_lun;
534 /* Persistent Reservation key */
535 u64 pr_res_key;
536 /* Used for sense data */
537 void *sense_buffer;
538 struct list_head se_delayed_node;
539 struct list_head se_lun_node;
540 struct list_head se_qf_node;
541 struct se_device *se_dev;
542 struct se_dev_entry *se_deve;
543 struct se_lun *se_lun;
544 /* Only used for internal passthrough and legacy TCM fabric modules */
545 struct se_session *se_sess;
546 struct se_tmr_req *se_tmr_req;
547 struct list_head se_queue_node;
548 struct list_head se_cmd_list;
549 struct completion cmd_wait_comp;
550 struct kref cmd_kref;
551 struct target_core_fabric_ops *se_tfo;
552 int (*execute_task)(struct se_task *);
553 void (*transport_complete_callback)(struct se_cmd *);
554
555 unsigned char *t_task_cdb;
556 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE];
557 unsigned long long t_task_lba;
558 int t_tasks_failed;
559 u32 t_tasks_sg_chained_no;
560 atomic_t t_fe_count;
561 atomic_t t_se_count;
562 atomic_t t_task_cdbs_left;
563 atomic_t t_task_cdbs_ex_left;
564 atomic_t t_task_cdbs_sent;
565 atomic_t t_transport_aborted;
566 atomic_t t_transport_active;
567 atomic_t t_transport_complete;
568 atomic_t t_transport_queue_active;
569 atomic_t t_transport_sent;
570 atomic_t t_transport_stop;
571 atomic_t transport_dev_active;
572 atomic_t transport_lun_active;
573 atomic_t transport_lun_fe_stop;
574 atomic_t transport_lun_stop;
575 spinlock_t t_state_lock;
576 struct completion t_transport_stop_comp;
577 struct completion transport_lun_fe_stop_comp;
578 struct completion transport_lun_stop_comp;
579 struct scatterlist *t_tasks_sg_chained;
580
581 struct work_struct work;
582
583 struct scatterlist *t_data_sg;
584 unsigned int t_data_nents;
585 void *t_data_vmap;
586 struct scatterlist *t_bidi_data_sg;
587 unsigned int t_bidi_data_nents;
588
589 /* Used for BIDI READ */
590 struct list_head t_task_list;
591 u32 t_task_list_num;
592
593 };
594
595 struct se_tmr_req {
596 /* Task Management function to be preformed */
597 u8 function;
598 /* Task Management response to send */
599 u8 response;
600 int call_transport;
601 /* Reference to ITT that Task Mgmt should be preformed */
602 u32 ref_task_tag;
603 /* 64-bit encoded SAM LUN from $FABRIC_MOD TMR header */
604 u64 ref_task_lun;
605 void *fabric_tmr_ptr;
606 struct se_cmd *task_cmd;
607 struct se_cmd *ref_cmd;
608 struct se_device *tmr_dev;
609 struct se_lun *tmr_lun;
610 struct list_head tmr_list;
611 };
612
613 struct se_ua {
614 u8 ua_asc;
615 u8 ua_ascq;
616 struct se_node_acl *ua_nacl;
617 struct list_head ua_dev_list;
618 struct list_head ua_nacl_list;
619 };
620
621 struct se_node_acl {
622 char initiatorname[TRANSPORT_IQN_LEN];
623 /* Used to signal demo mode created ACL, disabled by default */
624 bool dynamic_node_acl;
625 u32 queue_depth;
626 u32 acl_index;
627 u64 num_cmds;
628 u64 read_bytes;
629 u64 write_bytes;
630 spinlock_t stats_lock;
631 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
632 atomic_t acl_pr_ref_count;
633 struct se_dev_entry *device_list;
634 struct se_session *nacl_sess;
635 struct se_portal_group *se_tpg;
636 spinlock_t device_list_lock;
637 spinlock_t nacl_sess_lock;
638 struct config_group acl_group;
639 struct config_group acl_attrib_group;
640 struct config_group acl_auth_group;
641 struct config_group acl_param_group;
642 struct config_group acl_fabric_stat_group;
643 struct config_group *acl_default_groups[5];
644 struct list_head acl_list;
645 struct list_head acl_sess_list;
646 };
647
648 struct se_session {
649 unsigned sess_tearing_down:1;
650 u64 sess_bin_isid;
651 struct se_node_acl *se_node_acl;
652 struct se_portal_group *se_tpg;
653 void *fabric_sess_ptr;
654 struct list_head sess_list;
655 struct list_head sess_acl_list;
656 struct list_head sess_cmd_list;
657 struct list_head sess_wait_list;
658 spinlock_t sess_cmd_lock;
659 };
660
661 struct se_device;
662 struct se_transform_info;
663 struct scatterlist;
664
665 struct se_ml_stat_grps {
666 struct config_group stat_group;
667 struct config_group scsi_auth_intr_group;
668 struct config_group scsi_att_intr_port_group;
669 };
670
671 struct se_lun_acl {
672 char initiatorname[TRANSPORT_IQN_LEN];
673 u32 mapped_lun;
674 struct se_node_acl *se_lun_nacl;
675 struct se_lun *se_lun;
676 struct list_head lacl_list;
677 struct config_group se_lun_group;
678 struct se_ml_stat_grps ml_stat_grps;
679 };
680
681 struct se_dev_entry {
682 bool def_pr_registered;
683 /* See transport_lunflags_table */
684 u32 lun_flags;
685 u32 deve_cmds;
686 u32 mapped_lun;
687 u32 average_bytes;
688 u32 last_byte_count;
689 u32 total_cmds;
690 u32 total_bytes;
691 u64 pr_res_key;
692 u64 creation_time;
693 u32 attach_count;
694 u64 read_bytes;
695 u64 write_bytes;
696 atomic_t ua_count;
697 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
698 atomic_t pr_ref_count;
699 struct se_lun_acl *se_lun_acl;
700 spinlock_t ua_lock;
701 struct se_lun *se_lun;
702 struct list_head alua_port_list;
703 struct list_head ua_list;
704 };
705
706 struct se_dev_limits {
707 /* Max supported HW queue depth */
708 u32 hw_queue_depth;
709 /* Max supported virtual queue depth */
710 u32 queue_depth;
711 /* From include/linux/blkdev.h for the other HW/SW limits. */
712 struct queue_limits limits;
713 };
714
715 struct se_dev_attrib {
716 int emulate_dpo;
717 int emulate_fua_write;
718 int emulate_fua_read;
719 int emulate_write_cache;
720 int emulate_ua_intlck_ctrl;
721 int emulate_tas;
722 int emulate_tpu;
723 int emulate_tpws;
724 int emulate_reservations;
725 int emulate_alua;
726 int enforce_pr_isids;
727 int is_nonrot;
728 int emulate_rest_reord;
729 u32 hw_block_size;
730 u32 block_size;
731 u32 hw_max_sectors;
732 u32 max_sectors;
733 u32 optimal_sectors;
734 u32 hw_queue_depth;
735 u32 queue_depth;
736 u32 max_unmap_lba_count;
737 u32 max_unmap_block_desc_count;
738 u32 unmap_granularity;
739 u32 unmap_granularity_alignment;
740 struct se_subsystem_dev *da_sub_dev;
741 struct config_group da_group;
742 };
743
744 struct se_dev_stat_grps {
745 struct config_group stat_group;
746 struct config_group scsi_dev_group;
747 struct config_group scsi_tgt_dev_group;
748 struct config_group scsi_lu_group;
749 };
750
751 struct se_subsystem_dev {
752 /* Used for struct se_subsystem_dev-->se_dev_alias, must be less than PAGE_SIZE */
753 #define SE_DEV_ALIAS_LEN 512
754 unsigned char se_dev_alias[SE_DEV_ALIAS_LEN];
755 /* Used for struct se_subsystem_dev->se_dev_udev_path[], must be less than PAGE_SIZE */
756 #define SE_UDEV_PATH_LEN 512
757 unsigned char se_dev_udev_path[SE_UDEV_PATH_LEN];
758 u32 su_dev_flags;
759 struct se_hba *se_dev_hba;
760 struct se_device *se_dev_ptr;
761 struct se_dev_attrib se_dev_attrib;
762 /* T10 Asymmetric Logical Unit Assignment for Target Ports */
763 struct t10_alua t10_alua;
764 /* T10 Inquiry and VPD WWN Information */
765 struct t10_wwn t10_wwn;
766 /* T10 SPC-2 + SPC-3 Reservations */
767 struct t10_reservation t10_pr;
768 spinlock_t se_dev_lock;
769 void *se_dev_su_ptr;
770 struct config_group se_dev_group;
771 /* For T10 Reservations */
772 struct config_group se_dev_pr_group;
773 /* For target_core_stat.c groups */
774 struct se_dev_stat_grps dev_stat_grps;
775 };
776
777 struct se_device {
778 /* RELATIVE TARGET PORT IDENTIFER Counter */
779 u16 dev_rpti_counter;
780 /* Used for SAM Task Attribute ordering */
781 u32 dev_cur_ordered_id;
782 u32 dev_flags;
783 u32 dev_port_count;
784 /* See transport_device_status_table */
785 u32 dev_status;
786 /* Physical device queue depth */
787 u32 queue_depth;
788 /* Used for SPC-2 reservations enforce of ISIDs */
789 u64 dev_res_bin_isid;
790 t10_task_attr_index_t dev_task_attr_type;
791 /* Pointer to transport specific device structure */
792 void *dev_ptr;
793 u32 dev_index;
794 u64 creation_time;
795 u32 num_resets;
796 u64 num_cmds;
797 u64 read_bytes;
798 u64 write_bytes;
799 spinlock_t stats_lock;
800 /* Active commands on this virtual SE device */
801 atomic_t simple_cmds;
802 atomic_t dev_ordered_id;
803 atomic_t execute_tasks;
804 atomic_t dev_ordered_sync;
805 atomic_t dev_qf_count;
806 struct se_obj dev_obj;
807 struct se_obj dev_access_obj;
808 struct se_obj dev_export_obj;
809 struct se_queue_obj dev_queue_obj;
810 spinlock_t delayed_cmd_lock;
811 spinlock_t execute_task_lock;
812 spinlock_t dev_reservation_lock;
813 spinlock_t dev_status_lock;
814 spinlock_t se_port_lock;
815 spinlock_t se_tmr_lock;
816 spinlock_t qf_cmd_lock;
817 /* Used for legacy SPC-2 reservationsa */
818 struct se_node_acl *dev_reserved_node_acl;
819 /* Used for ALUA Logical Unit Group membership */
820 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
821 /* Used for SPC-3 Persistent Reservations */
822 struct t10_pr_registration *dev_pr_res_holder;
823 struct list_head dev_sep_list;
824 struct list_head dev_tmr_list;
825 /* Pointer to descriptor for processing thread */
826 struct task_struct *process_thread;
827 struct work_struct qf_work_queue;
828 struct list_head delayed_cmd_list;
829 struct list_head execute_task_list;
830 struct list_head state_task_list;
831 struct list_head qf_cmd_list;
832 /* Pointer to associated SE HBA */
833 struct se_hba *se_hba;
834 struct se_subsystem_dev *se_sub_dev;
835 /* Pointer to template of function pointers for transport */
836 struct se_subsystem_api *transport;
837 /* Linked list for struct se_hba struct se_device list */
838 struct list_head dev_list;
839 };
840
841 struct se_hba {
842 u16 hba_tpgt;
843 u32 hba_id;
844 /* See hba_flags_table */
845 u32 hba_flags;
846 /* Virtual iSCSI devices attached. */
847 u32 dev_count;
848 u32 hba_index;
849 /* Pointer to transport specific host structure. */
850 void *hba_ptr;
851 /* Linked list for struct se_device */
852 struct list_head hba_dev_list;
853 struct list_head hba_node;
854 spinlock_t device_lock;
855 struct config_group hba_group;
856 struct mutex hba_access_mutex;
857 struct se_subsystem_api *transport;
858 };
859
860 struct se_port_stat_grps {
861 struct config_group stat_group;
862 struct config_group scsi_port_group;
863 struct config_group scsi_tgt_port_group;
864 struct config_group scsi_transport_group;
865 };
866
867 struct se_lun {
868 /* See transport_lun_status_table */
869 enum transport_lun_status_table lun_status;
870 u32 lun_access;
871 u32 lun_flags;
872 u32 unpacked_lun;
873 atomic_t lun_acl_count;
874 spinlock_t lun_acl_lock;
875 spinlock_t lun_cmd_lock;
876 spinlock_t lun_sep_lock;
877 struct completion lun_shutdown_comp;
878 struct list_head lun_cmd_list;
879 struct list_head lun_acl_list;
880 struct se_device *lun_se_dev;
881 struct se_port *lun_sep;
882 struct config_group lun_group;
883 struct se_port_stat_grps port_stat_grps;
884 };
885
886 struct scsi_port_stats {
887 u64 cmd_pdus;
888 u64 tx_data_octets;
889 u64 rx_data_octets;
890 };
891
892 struct se_port {
893 /* RELATIVE TARGET PORT IDENTIFER */
894 u16 sep_rtpi;
895 int sep_tg_pt_secondary_stat;
896 int sep_tg_pt_secondary_write_md;
897 u32 sep_index;
898 struct scsi_port_stats sep_stats;
899 /* Used for ALUA Target Port Groups membership */
900 atomic_t sep_tg_pt_secondary_offline;
901 /* Used for PR ALL_TG_PT=1 */
902 atomic_t sep_tg_pt_ref_cnt;
903 spinlock_t sep_alua_lock;
904 struct mutex sep_tg_pt_md_mutex;
905 struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
906 struct se_lun *sep_lun;
907 struct se_portal_group *sep_tpg;
908 struct list_head sep_alua_list;
909 struct list_head sep_list;
910 };
911
912 struct se_tpg_np {
913 struct se_portal_group *tpg_np_parent;
914 struct config_group tpg_np_group;
915 };
916
917 struct se_portal_group {
918 /* Type of target portal group, see transport_tpg_type_table */
919 enum transport_tpg_type_table se_tpg_type;
920 /* Number of ACLed Initiator Nodes for this TPG */
921 u32 num_node_acls;
922 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
923 atomic_t tpg_pr_ref_count;
924 /* Spinlock for adding/removing ACLed Nodes */
925 spinlock_t acl_node_lock;
926 /* Spinlock for adding/removing sessions */
927 spinlock_t session_lock;
928 spinlock_t tpg_lun_lock;
929 /* Pointer to $FABRIC_MOD portal group */
930 void *se_tpg_fabric_ptr;
931 struct list_head se_tpg_node;
932 /* linked list for initiator ACL list */
933 struct list_head acl_node_list;
934 struct se_lun *tpg_lun_list;
935 struct se_lun tpg_virt_lun0;
936 /* List of TCM sessions associated wth this TPG */
937 struct list_head tpg_sess_list;
938 /* Pointer to $FABRIC_MOD dependent code */
939 struct target_core_fabric_ops *se_tpg_tfo;
940 struct se_wwn *se_tpg_wwn;
941 struct config_group tpg_group;
942 struct config_group *tpg_default_groups[6];
943 struct config_group tpg_lun_group;
944 struct config_group tpg_np_group;
945 struct config_group tpg_acl_group;
946 struct config_group tpg_attrib_group;
947 struct config_group tpg_param_group;
948 };
949
950 struct se_wwn {
951 struct target_fabric_configfs *wwn_tf;
952 struct config_group wwn_group;
953 struct config_group *wwn_default_groups[2];
954 struct config_group fabric_stat_group;
955 };
956
957 #endif /* TARGET_CORE_BASE_H */