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