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