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