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