target: pass sense_reason as a return value
[cascardo/linux.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-rc2-ml"
13 #define TARGET_CORE_VERSION             TARGET_CORE_MOD_VERSION
14
15 /* Maximum Number of LUNs per Target Portal Group */
16 /* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
17 #define TRANSPORT_MAX_LUNS_PER_TPG              256
18 /*
19  * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
20  *
21  * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
22  * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
23  * 16-byte CDBs by default and require an extra allocation for
24  * 32-byte CDBs to because of legacy issues.
25  *
26  * Within TCM Core there are no such legacy limitiations, so we go ahead
27  * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
28  * within all TCM Core and subsystem plugin code.
29  */
30 #define TCM_MAX_COMMAND_SIZE                    32
31 /*
32  * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
33  * defined 96, but the real limit is 252 (or 260 including the header)
34  */
35 #define TRANSPORT_SENSE_BUFFER                  SCSI_SENSE_BUFFERSIZE
36 /* Used by transport_send_check_condition_and_sense() */
37 #define SPC_SENSE_KEY_OFFSET                    2
38 #define SPC_ADD_SENSE_LEN_OFFSET                7
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 /* Attempts before moving from SHORT to LONG */
59 #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD   3
60 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT  3  /* In milliseconds */
61 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG   10 /* In milliseconds */
62
63 #define PYX_TRANSPORT_STATUS_INTERVAL           5 /* In seconds */
64
65 /* struct se_dev_attrib sanity values */
66 /* Default max_unmap_lba_count */
67 #define DA_MAX_UNMAP_LBA_COUNT                  0
68 /* Default max_unmap_block_desc_count */
69 #define DA_MAX_UNMAP_BLOCK_DESC_COUNT           0
70 /* Default unmap_granularity */
71 #define DA_UNMAP_GRANULARITY_DEFAULT            0
72 /* Default unmap_granularity_alignment */
73 #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT  0
74 /* Default max transfer length */
75 #define DA_FABRIC_MAX_SECTORS                   8192
76 /* Emulation for Direct Page Out */
77 #define DA_EMULATE_DPO                          0
78 /* Emulation for Forced Unit Access WRITEs */
79 #define DA_EMULATE_FUA_WRITE                    1
80 /* Emulation for Forced Unit Access READs */
81 #define DA_EMULATE_FUA_READ                     0
82 /* Emulation for WriteCache and SYNCHRONIZE_CACHE */
83 #define DA_EMULATE_WRITE_CACHE                  0
84 /* Emulation for UNIT ATTENTION Interlock Control */
85 #define DA_EMULATE_UA_INTLLCK_CTRL              0
86 /* Emulation for TASK_ABORTED status (TAS) by default */
87 #define DA_EMULATE_TAS                          1
88 /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
89 #define DA_EMULATE_TPU                          0
90 /*
91  * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
92  * block/blk-lib.c:blkdev_issue_discard()
93  */
94 #define DA_EMULATE_TPWS                         0
95 /* No Emulation for PSCSI by default */
96 #define DA_EMULATE_ALUA                         0
97 /* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
98 #define DA_ENFORCE_PR_ISIDS                     1
99 #define DA_STATUS_MAX_SECTORS_MIN               16
100 #define DA_STATUS_MAX_SECTORS_MAX               8192
101 /* By default don't report non-rotating (solid state) medium */
102 #define DA_IS_NONROT                            0
103 /* Queue Algorithm Modifier default for restricted reordering in control mode page */
104 #define DA_EMULATE_REST_REORD                   0
105
106 #define SE_INQUIRY_BUF                          512
107 #define SE_MODE_PAGE_BUF                        512
108 #define SE_SENSE_BUF                            96
109
110 /* struct se_hba->hba_flags */
111 enum hba_flags_table {
112         HBA_FLAGS_INTERNAL_USE  = 0x01,
113         HBA_FLAGS_PSCSI_MODE    = 0x02,
114 };
115
116 /* struct se_lun->lun_status */
117 enum transport_lun_status_table {
118         TRANSPORT_LUN_STATUS_FREE = 0,
119         TRANSPORT_LUN_STATUS_ACTIVE = 1,
120 };
121
122 /* struct se_portal_group->se_tpg_type */
123 enum transport_tpg_type_table {
124         TRANSPORT_TPG_TYPE_NORMAL = 0,
125         TRANSPORT_TPG_TYPE_DISCOVERY = 1,
126 };
127
128 /* Special transport agnostic struct se_cmd->t_states */
129 enum transport_state_table {
130         TRANSPORT_NO_STATE      = 0,
131         TRANSPORT_NEW_CMD       = 1,
132         TRANSPORT_WRITE_PENDING = 3,
133         TRANSPORT_PROCESSING    = 5,
134         TRANSPORT_COMPLETE      = 6,
135         TRANSPORT_ISTATE_PROCESSING = 11,
136         TRANSPORT_COMPLETE_QF_WP = 18,
137         TRANSPORT_COMPLETE_QF_OK = 19,
138 };
139
140 /* Used for struct se_cmd->se_cmd_flags */
141 enum se_cmd_flags_table {
142         SCF_SUPPORTED_SAM_OPCODE        = 0x00000001,
143         SCF_TRANSPORT_TASK_SENSE        = 0x00000002,
144         SCF_EMULATED_TASK_SENSE         = 0x00000004,
145         SCF_SCSI_DATA_CDB               = 0x00000008,
146         SCF_SCSI_TMR_CDB                = 0x00000010,
147         SCF_FUA                         = 0x00000080,
148         SCF_SE_LUN_CMD                  = 0x00000100,
149         SCF_BIDI                        = 0x00000400,
150         SCF_SENT_CHECK_CONDITION        = 0x00000800,
151         SCF_OVERFLOW_BIT                = 0x00001000,
152         SCF_UNDERFLOW_BIT               = 0x00002000,
153         SCF_SENT_DELAYED_TAS            = 0x00004000,
154         SCF_ALUA_NON_OPTIMIZED          = 0x00008000,
155         SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00020000,
156         SCF_ACK_KREF                    = 0x00040000,
157 };
158
159 /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
160 enum transport_lunflags_table {
161         TRANSPORT_LUNFLAGS_NO_ACCESS            = 0x00,
162         TRANSPORT_LUNFLAGS_INITIATOR_ACCESS     = 0x01,
163         TRANSPORT_LUNFLAGS_READ_ONLY            = 0x02,
164         TRANSPORT_LUNFLAGS_READ_WRITE           = 0x04,
165 };
166
167 /*
168  * Used by transport_send_check_condition_and_sense()
169  * to signal which ASC/ASCQ sense payload should be built.
170  */
171 typedef unsigned __bitwise__ sense_reason_t;
172
173 enum tcm_sense_reason_table {
174 #define R(x)    (__force sense_reason_t )(x)
175         TCM_NON_EXISTENT_LUN                    = R(0x01),
176         TCM_UNSUPPORTED_SCSI_OPCODE             = R(0x02),
177         TCM_INCORRECT_AMOUNT_OF_DATA            = R(0x03),
178         TCM_UNEXPECTED_UNSOLICITED_DATA         = R(0x04),
179         TCM_SERVICE_CRC_ERROR                   = R(0x05),
180         TCM_SNACK_REJECTED                      = R(0x06),
181         TCM_SECTOR_COUNT_TOO_MANY               = R(0x07),
182         TCM_INVALID_CDB_FIELD                   = R(0x08),
183         TCM_INVALID_PARAMETER_LIST              = R(0x09),
184         TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE  = R(0x0a),
185         TCM_UNKNOWN_MODE_PAGE                   = R(0x0b),
186         TCM_WRITE_PROTECTED                     = R(0x0c),
187         TCM_CHECK_CONDITION_ABORT_CMD           = R(0x0d),
188         TCM_CHECK_CONDITION_UNIT_ATTENTION      = R(0x0e),
189         TCM_CHECK_CONDITION_NOT_READY           = R(0x0f),
190         TCM_RESERVATION_CONFLICT                = R(0x10),
191         TCM_ADDRESS_OUT_OF_RANGE                = R(0x11),
192         TCM_OUT_OF_RESOURCES                    = R(0x12),
193 #undef R
194 };
195
196 enum target_sc_flags_table {
197         TARGET_SCF_BIDI_OP              = 0x01,
198         TARGET_SCF_ACK_KREF             = 0x02,
199         TARGET_SCF_UNKNOWN_SIZE         = 0x04,
200 };
201
202 /* fabric independent task management function values */
203 enum tcm_tmreq_table {
204         TMR_ABORT_TASK          = 1,
205         TMR_ABORT_TASK_SET      = 2,
206         TMR_CLEAR_ACA           = 3,
207         TMR_CLEAR_TASK_SET      = 4,
208         TMR_LUN_RESET           = 5,
209         TMR_TARGET_WARM_RESET   = 6,
210         TMR_TARGET_COLD_RESET   = 7,
211         TMR_FABRIC_TMR          = 255,
212 };
213
214 /* fabric independent task management response values */
215 enum tcm_tmrsp_table {
216         TMR_FUNCTION_COMPLETE           = 0,
217         TMR_TASK_DOES_NOT_EXIST         = 1,
218         TMR_LUN_DOES_NOT_EXIST          = 2,
219         TMR_TASK_STILL_ALLEGIANT        = 3,
220         TMR_TASK_FAILOVER_NOT_SUPPORTED = 4,
221         TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED    = 5,
222         TMR_FUNCTION_AUTHORIZATION_FAILED = 6,
223         TMR_FUNCTION_REJECTED           = 255,
224 };
225
226 /*
227  * Used for target SCSI statistics
228  */
229 typedef enum {
230         SCSI_INST_INDEX,
231         SCSI_DEVICE_INDEX,
232         SCSI_AUTH_INTR_INDEX,
233         SCSI_INDEX_TYPE_MAX
234 } scsi_index_t;
235
236 struct se_cmd;
237
238 struct t10_alua {
239         /* ALUA Target Port Group ID */
240         u16     alua_tg_pt_gps_counter;
241         u32     alua_tg_pt_gps_count;
242         spinlock_t tg_pt_gps_lock;
243         struct se_device *t10_dev;
244         /* Used for default ALUA Target Port Group */
245         struct t10_alua_tg_pt_gp *default_tg_pt_gp;
246         /* Used for default ALUA Target Port Group ConfigFS group */
247         struct config_group alua_tg_pt_gps_group;
248         struct list_head tg_pt_gps_list;
249 };
250
251 struct t10_alua_lu_gp {
252         u16     lu_gp_id;
253         int     lu_gp_valid_id;
254         u32     lu_gp_members;
255         atomic_t lu_gp_ref_cnt;
256         spinlock_t lu_gp_lock;
257         struct config_group lu_gp_group;
258         struct list_head lu_gp_node;
259         struct list_head lu_gp_mem_list;
260 };
261
262 struct t10_alua_lu_gp_member {
263         bool lu_gp_assoc;
264         atomic_t lu_gp_mem_ref_cnt;
265         spinlock_t lu_gp_mem_lock;
266         struct t10_alua_lu_gp *lu_gp;
267         struct se_device *lu_gp_mem_dev;
268         struct list_head lu_gp_mem_list;
269 };
270
271 struct t10_alua_tg_pt_gp {
272         u16     tg_pt_gp_id;
273         int     tg_pt_gp_valid_id;
274         int     tg_pt_gp_alua_access_status;
275         int     tg_pt_gp_alua_access_type;
276         int     tg_pt_gp_nonop_delay_msecs;
277         int     tg_pt_gp_trans_delay_msecs;
278         int     tg_pt_gp_implict_trans_secs;
279         int     tg_pt_gp_pref;
280         int     tg_pt_gp_write_metadata;
281         /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
282 #define ALUA_MD_BUF_LEN                         1024
283         u32     tg_pt_gp_md_buf_len;
284         u32     tg_pt_gp_members;
285         atomic_t tg_pt_gp_alua_access_state;
286         atomic_t tg_pt_gp_ref_cnt;
287         spinlock_t tg_pt_gp_lock;
288         struct mutex tg_pt_gp_md_mutex;
289         struct se_device *tg_pt_gp_dev;
290         struct config_group tg_pt_gp_group;
291         struct list_head tg_pt_gp_list;
292         struct list_head tg_pt_gp_mem_list;
293 };
294
295 struct t10_alua_tg_pt_gp_member {
296         bool tg_pt_gp_assoc;
297         atomic_t tg_pt_gp_mem_ref_cnt;
298         spinlock_t tg_pt_gp_mem_lock;
299         struct t10_alua_tg_pt_gp *tg_pt_gp;
300         struct se_port *tg_pt;
301         struct list_head tg_pt_gp_mem_list;
302 };
303
304 struct t10_vpd {
305         unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
306         int protocol_identifier_set;
307         u32 protocol_identifier;
308         u32 device_identifier_code_set;
309         u32 association;
310         u32 device_identifier_type;
311         struct list_head vpd_list;
312 };
313
314 struct t10_wwn {
315         char vendor[8];
316         char model[16];
317         char revision[4];
318         char unit_serial[INQUIRY_VPD_SERIAL_LEN];
319         spinlock_t t10_vpd_lock;
320         struct se_device *t10_dev;
321         struct config_group t10_wwn_group;
322         struct list_head t10_vpd_list;
323 };
324
325 struct t10_pr_registration {
326         /* Used for fabrics that contain WWN+ISID */
327 #define PR_REG_ISID_LEN                         16
328         /* PR_REG_ISID_LEN + ',i,0x' */
329 #define PR_REG_ISID_ID_LEN                      (PR_REG_ISID_LEN + 5)
330         char pr_reg_isid[PR_REG_ISID_LEN];
331         /* Used during APTPL metadata reading */
332 #define PR_APTPL_MAX_IPORT_LEN                  256
333         unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
334         /* Used during APTPL metadata reading */
335 #define PR_APTPL_MAX_TPORT_LEN                  256
336         unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
337         /* For writing out live meta data */
338         unsigned char *pr_aptpl_buf;
339         u16 pr_aptpl_rpti;
340         u16 pr_reg_tpgt;
341         /* Reservation effects all target ports */
342         int pr_reg_all_tg_pt;
343         /* Activate Persistence across Target Power Loss */
344         int pr_reg_aptpl;
345         int pr_res_holder;
346         int pr_res_type;
347         int pr_res_scope;
348         /* Used for fabric initiator WWPNs using a ISID */
349         bool isid_present_at_reg;
350         u32 pr_res_mapped_lun;
351         u32 pr_aptpl_target_lun;
352         u32 pr_res_generation;
353         u64 pr_reg_bin_isid;
354         u64 pr_res_key;
355         atomic_t pr_res_holders;
356         struct se_node_acl *pr_reg_nacl;
357         struct se_dev_entry *pr_reg_deve;
358         struct se_lun *pr_reg_tg_pt_lun;
359         struct list_head pr_reg_list;
360         struct list_head pr_reg_abort_list;
361         struct list_head pr_reg_aptpl_list;
362         struct list_head pr_reg_atp_list;
363         struct list_head pr_reg_atp_mem_list;
364 };
365
366 struct t10_reservation {
367         /* Reservation effects all target ports */
368         int pr_all_tg_pt;
369         /* Activate Persistence across Target Power Loss enabled
370          * for SCSI device */
371         int pr_aptpl_active;
372         /* Used by struct t10_reservation->pr_aptpl_buf_len */
373 #define PR_APTPL_BUF_LEN                        8192
374         u32 pr_aptpl_buf_len;
375         u32 pr_generation;
376         spinlock_t registration_lock;
377         spinlock_t aptpl_reg_lock;
378         /*
379          * This will always be set by one individual I_T Nexus.
380          * However with all_tg_pt=1, other I_T Nexus from the
381          * same initiator can access PR reg/res info on a different
382          * target port.
383          *
384          * There is also the 'All Registrants' case, where there is
385          * a single *pr_res_holder of the reservation, but all
386          * registrations are considered reservation holders.
387          */
388         struct se_node_acl *pr_res_holder;
389         struct list_head registration_list;
390         struct list_head aptpl_reg_list;
391 };
392
393 struct se_tmr_req {
394         /* Task Management function to be performed */
395         u8                      function;
396         /* Task Management response to send */
397         u8                      response;
398         int                     call_transport;
399         /* Reference to ITT that Task Mgmt should be performed */
400         u32                     ref_task_tag;
401         void                    *fabric_tmr_ptr;
402         struct se_cmd           *task_cmd;
403         struct se_device        *tmr_dev;
404         struct se_lun           *tmr_lun;
405         struct list_head        tmr_list;
406 };
407
408 struct se_cmd {
409         /* SAM response code being sent to initiator */
410         u8                      scsi_status;
411         u8                      scsi_asc;
412         u8                      scsi_ascq;
413         u16                     scsi_sense_length;
414         /* Delay for ALUA Active/NonOptimized state access in milliseconds */
415         int                     alua_nonop_delay;
416         /* See include/linux/dma-mapping.h */
417         enum dma_data_direction data_direction;
418         /* For SAM Task Attribute */
419         int                     sam_task_attr;
420         /* Transport protocol dependent state, see transport_state_table */
421         enum transport_state_table t_state;
422         /* Used to signal cmd->se_tfo->check_release_cmd() usage per cmd */
423         unsigned                check_release:1;
424         unsigned                cmd_wait_set:1;
425         unsigned                unknown_data_length:1;
426         /* See se_cmd_flags_table */
427         u32                     se_cmd_flags;
428         u32                     se_ordered_id;
429         /* Total size in bytes associated with command */
430         u32                     data_length;
431         u32                     residual_count;
432         u32                     orig_fe_lun;
433         /* Persistent Reservation key */
434         u64                     pr_res_key;
435         /* Used for sense data */
436         void                    *sense_buffer;
437         struct list_head        se_delayed_node;
438         struct list_head        se_lun_node;
439         struct list_head        se_qf_node;
440         struct se_device      *se_dev;
441         struct se_dev_entry   *se_deve;
442         struct se_lun           *se_lun;
443         /* Only used for internal passthrough and legacy TCM fabric modules */
444         struct se_session       *se_sess;
445         struct se_tmr_req       *se_tmr_req;
446         struct list_head        se_cmd_list;
447         struct completion       cmd_wait_comp;
448         struct kref             cmd_kref;
449         struct target_core_fabric_ops *se_tfo;
450         sense_reason_t          (*execute_cmd)(struct se_cmd *);
451         void (*transport_complete_callback)(struct se_cmd *);
452
453         unsigned char           *t_task_cdb;
454         unsigned char           __t_task_cdb[TCM_MAX_COMMAND_SIZE];
455         unsigned long long      t_task_lba;
456         atomic_t                t_fe_count;
457         unsigned int            transport_state;
458 #define CMD_T_ABORTED           (1 << 0)
459 #define CMD_T_ACTIVE            (1 << 1)
460 #define CMD_T_COMPLETE          (1 << 2)
461 #define CMD_T_QUEUED            (1 << 3)
462 #define CMD_T_SENT              (1 << 4)
463 #define CMD_T_STOP              (1 << 5)
464 #define CMD_T_FAILED            (1 << 6)
465 #define CMD_T_LUN_STOP          (1 << 7)
466 #define CMD_T_LUN_FE_STOP       (1 << 8)
467 #define CMD_T_DEV_ACTIVE        (1 << 9)
468 #define CMD_T_REQUEST_STOP      (1 << 10)
469 #define CMD_T_BUSY              (1 << 11)
470         spinlock_t              t_state_lock;
471         struct completion       t_transport_stop_comp;
472         struct completion       transport_lun_fe_stop_comp;
473         struct completion       transport_lun_stop_comp;
474
475         struct work_struct      work;
476
477         struct scatterlist      *t_data_sg;
478         unsigned int            t_data_nents;
479         void                    *t_data_vmap;
480         struct scatterlist      *t_bidi_data_sg;
481         unsigned int            t_bidi_data_nents;
482
483         struct list_head        state_list;
484         bool                    state_active;
485
486         /* old task stop completion, consider merging with some of the above */
487         struct completion       task_stop_comp;
488
489         /* backend private data */
490         void                    *priv;
491 };
492
493 struct se_ua {
494         u8                      ua_asc;
495         u8                      ua_ascq;
496         struct se_node_acl      *ua_nacl;
497         struct list_head        ua_dev_list;
498         struct list_head        ua_nacl_list;
499 };
500
501 struct se_node_acl {
502         char                    initiatorname[TRANSPORT_IQN_LEN];
503         /* Used to signal demo mode created ACL, disabled by default */
504         bool                    dynamic_node_acl;
505         bool                    acl_stop:1;
506         u32                     queue_depth;
507         u32                     acl_index;
508         u64                     num_cmds;
509         u64                     read_bytes;
510         u64                     write_bytes;
511         spinlock_t              stats_lock;
512         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
513         atomic_t                acl_pr_ref_count;
514         struct se_dev_entry     **device_list;
515         struct se_session       *nacl_sess;
516         struct se_portal_group *se_tpg;
517         spinlock_t              device_list_lock;
518         spinlock_t              nacl_sess_lock;
519         struct config_group     acl_group;
520         struct config_group     acl_attrib_group;
521         struct config_group     acl_auth_group;
522         struct config_group     acl_param_group;
523         struct config_group     acl_fabric_stat_group;
524         struct config_group     *acl_default_groups[5];
525         struct list_head        acl_list;
526         struct list_head        acl_sess_list;
527         struct completion       acl_free_comp;
528         struct kref             acl_kref;
529 };
530
531 struct se_session {
532         unsigned                sess_tearing_down:1;
533         u64                     sess_bin_isid;
534         struct se_node_acl      *se_node_acl;
535         struct se_portal_group *se_tpg;
536         void                    *fabric_sess_ptr;
537         struct list_head        sess_list;
538         struct list_head        sess_acl_list;
539         struct list_head        sess_cmd_list;
540         spinlock_t              sess_cmd_lock;
541         struct kref             sess_kref;
542 };
543
544 struct se_device;
545 struct se_transform_info;
546 struct scatterlist;
547
548 struct se_ml_stat_grps {
549         struct config_group     stat_group;
550         struct config_group     scsi_auth_intr_group;
551         struct config_group     scsi_att_intr_port_group;
552 };
553
554 struct se_lun_acl {
555         char                    initiatorname[TRANSPORT_IQN_LEN];
556         u32                     mapped_lun;
557         struct se_node_acl      *se_lun_nacl;
558         struct se_lun           *se_lun;
559         struct list_head        lacl_list;
560         struct config_group     se_lun_group;
561         struct se_ml_stat_grps  ml_stat_grps;
562 };
563
564 struct se_dev_entry {
565         bool                    def_pr_registered;
566         /* See transport_lunflags_table */
567         u32                     lun_flags;
568         u32                     deve_cmds;
569         u32                     mapped_lun;
570         u32                     average_bytes;
571         u32                     last_byte_count;
572         u32                     total_cmds;
573         u32                     total_bytes;
574         u64                     pr_res_key;
575         u64                     creation_time;
576         u32                     attach_count;
577         u64                     read_bytes;
578         u64                     write_bytes;
579         atomic_t                ua_count;
580         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
581         atomic_t                pr_ref_count;
582         struct se_lun_acl       *se_lun_acl;
583         spinlock_t              ua_lock;
584         struct se_lun           *se_lun;
585         struct list_head        alua_port_list;
586         struct list_head        ua_list;
587 };
588
589 struct se_dev_attrib {
590         int             emulate_dpo;
591         int             emulate_fua_write;
592         int             emulate_fua_read;
593         int             emulate_write_cache;
594         int             emulate_ua_intlck_ctrl;
595         int             emulate_tas;
596         int             emulate_tpu;
597         int             emulate_tpws;
598         int             enforce_pr_isids;
599         int             is_nonrot;
600         int             emulate_rest_reord;
601         u32             hw_block_size;
602         u32             block_size;
603         u32             hw_max_sectors;
604         u32             fabric_max_sectors;
605         u32             optimal_sectors;
606         u32             hw_queue_depth;
607         u32             queue_depth;
608         u32             max_unmap_lba_count;
609         u32             max_unmap_block_desc_count;
610         u32             unmap_granularity;
611         u32             unmap_granularity_alignment;
612         struct se_device *da_dev;
613         struct config_group da_group;
614 };
615
616 struct se_dev_stat_grps {
617         struct config_group stat_group;
618         struct config_group scsi_dev_group;
619         struct config_group scsi_tgt_dev_group;
620         struct config_group scsi_lu_group;
621 };
622
623 struct se_device {
624         /* RELATIVE TARGET PORT IDENTIFER Counter */
625         u16                     dev_rpti_counter;
626         /* Used for SAM Task Attribute ordering */
627         u32                     dev_cur_ordered_id;
628         u32                     dev_flags;
629 #define DF_CONFIGURED                           0x00000001
630 #define DF_FIRMWARE_VPD_UNIT_SERIAL             0x00000002
631 #define DF_EMULATED_VPD_UNIT_SERIAL             0x00000004
632 #define DF_USING_UDEV_PATH                      0x00000008
633 #define DF_USING_ALIAS                          0x00000010
634         u32                     dev_port_count;
635         /* Physical device queue depth */
636         u32                     queue_depth;
637         /* Used for SPC-2 reservations enforce of ISIDs */
638         u64                     dev_res_bin_isid;
639         /* Pointer to transport specific device structure */
640         u32                     dev_index;
641         u64                     creation_time;
642         u32                     num_resets;
643         u64                     num_cmds;
644         u64                     read_bytes;
645         u64                     write_bytes;
646         spinlock_t              stats_lock;
647         /* Active commands on this virtual SE device */
648         atomic_t                simple_cmds;
649         atomic_t                dev_ordered_id;
650         atomic_t                dev_ordered_sync;
651         atomic_t                dev_qf_count;
652         int                     export_count;
653         spinlock_t              delayed_cmd_lock;
654         spinlock_t              execute_task_lock;
655         spinlock_t              dev_reservation_lock;
656         unsigned int            dev_reservation_flags;
657 #define DRF_SPC2_RESERVATIONS                   0x00000001
658 #define DRF_SPC2_RESERVATIONS_WITH_ISID         0x00000002
659         spinlock_t              se_port_lock;
660         spinlock_t              se_tmr_lock;
661         spinlock_t              qf_cmd_lock;
662         /* Used for legacy SPC-2 reservationsa */
663         struct se_node_acl      *dev_reserved_node_acl;
664         /* Used for ALUA Logical Unit Group membership */
665         struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
666         /* Used for SPC-3 Persistent Reservations */
667         struct t10_pr_registration *dev_pr_res_holder;
668         struct list_head        dev_sep_list;
669         struct list_head        dev_tmr_list;
670         struct workqueue_struct *tmr_wq;
671         struct work_struct      qf_work_queue;
672         struct list_head        delayed_cmd_list;
673         struct list_head        state_list;
674         struct list_head        qf_cmd_list;
675         /* Pointer to associated SE HBA */
676         struct se_hba           *se_hba;
677         /* T10 Inquiry and VPD WWN Information */
678         struct t10_wwn          t10_wwn;
679         /* T10 Asymmetric Logical Unit Assignment for Target Ports */
680         struct t10_alua         t10_alua;
681         /* T10 SPC-2 + SPC-3 Reservations */
682         struct t10_reservation  t10_pr;
683         struct se_dev_attrib    dev_attrib;
684         struct config_group     dev_group;
685         struct config_group     dev_pr_group;
686         struct se_dev_stat_grps dev_stat_grps;
687 #define SE_DEV_ALIAS_LEN 512            /* must be less than PAGE_SIZE */
688         unsigned char           dev_alias[SE_DEV_ALIAS_LEN];
689 #define SE_UDEV_PATH_LEN 512            /* must be less than PAGE_SIZE */
690         unsigned char           udev_path[SE_UDEV_PATH_LEN];
691         /* Pointer to template of function pointers for transport */
692         struct se_subsystem_api *transport;
693         /* Linked list for struct se_hba struct se_device list */
694         struct list_head        dev_list;
695 };
696
697 struct se_hba {
698         u16                     hba_tpgt;
699         u32                     hba_id;
700         /* See hba_flags_table */
701         u32                     hba_flags;
702         /* Virtual iSCSI devices attached. */
703         u32                     dev_count;
704         u32                     hba_index;
705         /* Pointer to transport specific host structure. */
706         void                    *hba_ptr;
707         struct list_head        hba_node;
708         spinlock_t              device_lock;
709         struct config_group     hba_group;
710         struct mutex            hba_access_mutex;
711         struct se_subsystem_api *transport;
712 };
713
714 struct se_port_stat_grps {
715         struct config_group stat_group;
716         struct config_group scsi_port_group;
717         struct config_group scsi_tgt_port_group;
718         struct config_group scsi_transport_group;
719 };
720
721 struct se_lun {
722         /* See transport_lun_status_table */
723         enum transport_lun_status_table lun_status;
724         u32                     lun_access;
725         u32                     lun_flags;
726         u32                     unpacked_lun;
727         atomic_t                lun_acl_count;
728         spinlock_t              lun_acl_lock;
729         spinlock_t              lun_cmd_lock;
730         spinlock_t              lun_sep_lock;
731         struct completion       lun_shutdown_comp;
732         struct list_head        lun_cmd_list;
733         struct list_head        lun_acl_list;
734         struct se_device        *lun_se_dev;
735         struct se_port          *lun_sep;
736         struct config_group     lun_group;
737         struct se_port_stat_grps port_stat_grps;
738 };
739
740 struct scsi_port_stats {
741        u64     cmd_pdus;
742        u64     tx_data_octets;
743        u64     rx_data_octets;
744 };
745
746 struct se_port {
747         /* RELATIVE TARGET PORT IDENTIFER */
748         u16             sep_rtpi;
749         int             sep_tg_pt_secondary_stat;
750         int             sep_tg_pt_secondary_write_md;
751         u32             sep_index;
752         struct scsi_port_stats sep_stats;
753         /* Used for ALUA Target Port Groups membership */
754         atomic_t        sep_tg_pt_secondary_offline;
755         /* Used for PR ALL_TG_PT=1 */
756         atomic_t        sep_tg_pt_ref_cnt;
757         spinlock_t      sep_alua_lock;
758         struct mutex    sep_tg_pt_md_mutex;
759         struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
760         struct se_lun *sep_lun;
761         struct se_portal_group *sep_tpg;
762         struct list_head sep_alua_list;
763         struct list_head sep_list;
764 };
765
766 struct se_tpg_np {
767         struct se_portal_group *tpg_np_parent;
768         struct config_group     tpg_np_group;
769 };
770
771 struct se_portal_group {
772         /* Type of target portal group, see transport_tpg_type_table */
773         enum transport_tpg_type_table se_tpg_type;
774         /* Number of ACLed Initiator Nodes for this TPG */
775         u32                     num_node_acls;
776         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
777         atomic_t                tpg_pr_ref_count;
778         /* Spinlock for adding/removing ACLed Nodes */
779         spinlock_t              acl_node_lock;
780         /* Spinlock for adding/removing sessions */
781         spinlock_t              session_lock;
782         spinlock_t              tpg_lun_lock;
783         /* Pointer to $FABRIC_MOD portal group */
784         void                    *se_tpg_fabric_ptr;
785         struct list_head        se_tpg_node;
786         /* linked list for initiator ACL list */
787         struct list_head        acl_node_list;
788         struct se_lun           **tpg_lun_list;
789         struct se_lun           tpg_virt_lun0;
790         /* List of TCM sessions associated wth this TPG */
791         struct list_head        tpg_sess_list;
792         /* Pointer to $FABRIC_MOD dependent code */
793         struct target_core_fabric_ops *se_tpg_tfo;
794         struct se_wwn           *se_tpg_wwn;
795         struct config_group     tpg_group;
796         struct config_group     *tpg_default_groups[6];
797         struct config_group     tpg_lun_group;
798         struct config_group     tpg_np_group;
799         struct config_group     tpg_acl_group;
800         struct config_group     tpg_attrib_group;
801         struct config_group     tpg_param_group;
802 };
803
804 struct se_wwn {
805         struct target_fabric_configfs *wwn_tf;
806         struct config_group     wwn_group;
807         struct config_group     *wwn_default_groups[2];
808         struct config_group     fabric_stat_group;
809 };
810
811 #endif /* TARGET_CORE_BASE_H */