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