Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / 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 <linux/percpu_ida.h>
9 #include <scsi/scsi_cmnd.h>
10 #include <net/sock.h>
11 #include <net/tcp.h>
12
13 #define TARGET_CORE_MOD_VERSION         "v4.1.0"
14 #define TARGET_CORE_VERSION             TARGET_CORE_MOD_VERSION
15
16 /* Maximum Number of LUNs per Target Portal Group */
17 /* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
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_ADD_SENSE_LEN_OFFSET                7
40 #define SPC_DESC_TYPE_OFFSET                    8
41 #define SPC_ADDITIONAL_DESC_LEN_OFFSET          9
42 #define SPC_VALIDITY_OFFSET                     10
43 #define SPC_ASC_KEY_OFFSET                      12
44 #define SPC_ASCQ_KEY_OFFSET                     13
45 #define TRANSPORT_IQN_LEN                       224
46 /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
47 #define LU_GROUP_NAME_BUF                       256
48 /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
49 #define TG_PT_GROUP_NAME_BUF                    256
50 /* Used to parse VPD into struct t10_vpd */
51 #define VPD_TMP_BUF_SIZE                        254
52 /* Used by transport_generic_cmd_sequencer() */
53 #define READ_BLOCK_LEN                          6
54 #define READ_CAP_LEN                            8
55 #define READ_POSITION_LEN                       20
56 #define INQUIRY_LEN                             36
57 /* Used by transport_get_inquiry_vpd_serial() */
58 #define INQUIRY_VPD_SERIAL_LEN                  254
59 /* Used by transport_get_inquiry_vpd_device_ident() */
60 #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN       254
61
62 /* Attempts before moving from SHORT to LONG */
63 #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD   3
64 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT  3  /* In milliseconds */
65 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG   10 /* In milliseconds */
66
67 #define PYX_TRANSPORT_STATUS_INTERVAL           5 /* In seconds */
68
69 /* struct se_dev_attrib sanity values */
70 /* Default max_unmap_lba_count */
71 #define DA_MAX_UNMAP_LBA_COUNT                  0
72 /* Default max_unmap_block_desc_count */
73 #define DA_MAX_UNMAP_BLOCK_DESC_COUNT           0
74 /* Default unmap_granularity */
75 #define DA_UNMAP_GRANULARITY_DEFAULT            0
76 /* Default unmap_granularity_alignment */
77 #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT  0
78 /* Default max_write_same_len, disabled by default */
79 #define DA_MAX_WRITE_SAME_LEN                   0
80 /* Use a model alias based on the configfs backend device name */
81 #define DA_EMULATE_MODEL_ALIAS                  0
82 /* Emulation for Direct Page Out */
83 #define DA_EMULATE_DPO                          0
84 /* Emulation for Forced Unit Access WRITEs */
85 #define DA_EMULATE_FUA_WRITE                    1
86 /* Emulation for Forced Unit Access READs */
87 #define DA_EMULATE_FUA_READ                     0
88 /* Emulation for WriteCache and SYNCHRONIZE_CACHE */
89 #define DA_EMULATE_WRITE_CACHE                  0
90 /* Emulation for UNIT ATTENTION Interlock Control */
91 #define DA_EMULATE_UA_INTLLCK_CTRL              0
92 /* Emulation for TASK_ABORTED status (TAS) by default */
93 #define DA_EMULATE_TAS                          1
94 /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
95 #define DA_EMULATE_TPU                          0
96 /*
97  * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
98  * block/blk-lib.c:blkdev_issue_discard()
99  */
100 #define DA_EMULATE_TPWS                         0
101 /* Emulation for CompareAndWrite (AtomicTestandSet) by default */
102 #define DA_EMULATE_CAW                          1
103 /* Emulation for 3rd Party Copy (ExtendedCopy) by default */
104 #define DA_EMULATE_3PC                          1
105 /* No Emulation for PSCSI by default */
106 #define DA_EMULATE_ALUA                         0
107 /* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
108 #define DA_ENFORCE_PR_ISIDS                     1
109 /* Force SPC-3 PR Activate Persistence across Target Power Loss */
110 #define DA_FORCE_PR_APTPL                       0
111 #define DA_STATUS_MAX_SECTORS_MIN               16
112 #define DA_STATUS_MAX_SECTORS_MAX               8192
113 /* By default don't report non-rotating (solid state) medium */
114 #define DA_IS_NONROT                            0
115 /* Queue Algorithm Modifier default for restricted reordering in control mode page */
116 #define DA_EMULATE_REST_REORD                   0
117
118 #define SE_INQUIRY_BUF                          1024
119 #define SE_MODE_PAGE_BUF                        512
120 #define SE_SENSE_BUF                            96
121
122 /* struct se_hba->hba_flags */
123 enum hba_flags_table {
124         HBA_FLAGS_INTERNAL_USE  = 0x01,
125         HBA_FLAGS_PSCSI_MODE    = 0x02,
126 };
127
128 /* struct se_lun->lun_status */
129 enum transport_lun_status_table {
130         TRANSPORT_LUN_STATUS_FREE = 0,
131         TRANSPORT_LUN_STATUS_ACTIVE = 1,
132 };
133
134 /* struct se_portal_group->se_tpg_type */
135 enum transport_tpg_type_table {
136         TRANSPORT_TPG_TYPE_NORMAL = 0,
137         TRANSPORT_TPG_TYPE_DISCOVERY = 1,
138 };
139
140 /* Special transport agnostic struct se_cmd->t_states */
141 enum transport_state_table {
142         TRANSPORT_NO_STATE      = 0,
143         TRANSPORT_NEW_CMD       = 1,
144         TRANSPORT_WRITE_PENDING = 3,
145         TRANSPORT_PROCESSING    = 5,
146         TRANSPORT_COMPLETE      = 6,
147         TRANSPORT_ISTATE_PROCESSING = 11,
148         TRANSPORT_COMPLETE_QF_WP = 18,
149         TRANSPORT_COMPLETE_QF_OK = 19,
150 };
151
152 /* Used for struct se_cmd->se_cmd_flags */
153 enum se_cmd_flags_table {
154         SCF_SUPPORTED_SAM_OPCODE        = 0x00000001,
155         SCF_TRANSPORT_TASK_SENSE        = 0x00000002,
156         SCF_EMULATED_TASK_SENSE         = 0x00000004,
157         SCF_SCSI_DATA_CDB               = 0x00000008,
158         SCF_SCSI_TMR_CDB                = 0x00000010,
159         SCF_FUA                         = 0x00000080,
160         SCF_SE_LUN_CMD                  = 0x00000100,
161         SCF_BIDI                        = 0x00000400,
162         SCF_SENT_CHECK_CONDITION        = 0x00000800,
163         SCF_OVERFLOW_BIT                = 0x00001000,
164         SCF_UNDERFLOW_BIT               = 0x00002000,
165         SCF_SEND_DELAYED_TAS            = 0x00004000,
166         SCF_ALUA_NON_OPTIMIZED          = 0x00008000,
167         SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00020000,
168         SCF_COMPARE_AND_WRITE           = 0x00080000,
169         SCF_COMPARE_AND_WRITE_POST      = 0x00100000,
170 };
171
172 /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
173 enum transport_lunflags_table {
174         TRANSPORT_LUNFLAGS_NO_ACCESS            = 0x00,
175         TRANSPORT_LUNFLAGS_INITIATOR_ACCESS     = 0x01,
176         TRANSPORT_LUNFLAGS_READ_ONLY            = 0x02,
177         TRANSPORT_LUNFLAGS_READ_WRITE           = 0x04,
178 };
179
180 /*
181  * Used by transport_send_check_condition_and_sense()
182  * to signal which ASC/ASCQ sense payload should be built.
183  */
184 typedef unsigned __bitwise__ sense_reason_t;
185
186 enum tcm_sense_reason_table {
187 #define R(x)    (__force sense_reason_t )(x)
188         TCM_NO_SENSE                            = R(0x00),
189         TCM_NON_EXISTENT_LUN                    = R(0x01),
190         TCM_UNSUPPORTED_SCSI_OPCODE             = R(0x02),
191         TCM_INCORRECT_AMOUNT_OF_DATA            = R(0x03),
192         TCM_UNEXPECTED_UNSOLICITED_DATA         = R(0x04),
193         TCM_SERVICE_CRC_ERROR                   = R(0x05),
194         TCM_SNACK_REJECTED                      = R(0x06),
195         TCM_SECTOR_COUNT_TOO_MANY               = R(0x07),
196         TCM_INVALID_CDB_FIELD                   = R(0x08),
197         TCM_INVALID_PARAMETER_LIST              = R(0x09),
198         TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE  = R(0x0a),
199         TCM_UNKNOWN_MODE_PAGE                   = R(0x0b),
200         TCM_WRITE_PROTECTED                     = R(0x0c),
201         TCM_CHECK_CONDITION_ABORT_CMD           = R(0x0d),
202         TCM_CHECK_CONDITION_UNIT_ATTENTION      = R(0x0e),
203         TCM_CHECK_CONDITION_NOT_READY           = R(0x0f),
204         TCM_RESERVATION_CONFLICT                = R(0x10),
205         TCM_ADDRESS_OUT_OF_RANGE                = R(0x11),
206         TCM_OUT_OF_RESOURCES                    = R(0x12),
207         TCM_PARAMETER_LIST_LENGTH_ERROR         = R(0x13),
208         TCM_MISCOMPARE_VERIFY                   = R(0x14),
209         TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED    = R(0x15),
210         TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED  = R(0x16),
211         TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED  = R(0x17),
212 #undef R
213 };
214
215 enum target_sc_flags_table {
216         TARGET_SCF_BIDI_OP              = 0x01,
217         TARGET_SCF_ACK_KREF             = 0x02,
218         TARGET_SCF_UNKNOWN_SIZE         = 0x04,
219 };
220
221 /* fabric independent task management function values */
222 enum tcm_tmreq_table {
223         TMR_ABORT_TASK          = 1,
224         TMR_ABORT_TASK_SET      = 2,
225         TMR_CLEAR_ACA           = 3,
226         TMR_CLEAR_TASK_SET      = 4,
227         TMR_LUN_RESET           = 5,
228         TMR_TARGET_WARM_RESET   = 6,
229         TMR_TARGET_COLD_RESET   = 7,
230 };
231
232 /* fabric independent task management response values */
233 enum tcm_tmrsp_table {
234         TMR_FUNCTION_FAILED             = 0,
235         TMR_FUNCTION_COMPLETE           = 1,
236         TMR_TASK_DOES_NOT_EXIST         = 2,
237         TMR_LUN_DOES_NOT_EXIST          = 3,
238         TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED    = 4,
239         TMR_FUNCTION_REJECTED           = 5,
240 };
241
242 /*
243  * Used for target SCSI statistics
244  */
245 typedef enum {
246         SCSI_INST_INDEX,
247         SCSI_DEVICE_INDEX,
248         SCSI_AUTH_INTR_INDEX,
249         SCSI_INDEX_TYPE_MAX
250 } scsi_index_t;
251
252 struct se_cmd;
253
254 struct t10_alua_lba_map_member {
255         struct list_head lba_map_mem_list;
256         int lba_map_mem_alua_state;
257         int lba_map_mem_alua_pg_id;
258 };
259
260 struct t10_alua_lba_map {
261         u64 lba_map_first_lba;
262         u64 lba_map_last_lba;
263         struct list_head lba_map_list;
264         struct list_head lba_map_mem_list;
265 };
266
267 struct t10_alua {
268         /* ALUA Target Port Group ID */
269         u16     alua_tg_pt_gps_counter;
270         u32     alua_tg_pt_gps_count;
271         /* Referrals support */
272         spinlock_t lba_map_lock;
273         u32     lba_map_segment_size;
274         u32     lba_map_segment_multiplier;
275         struct list_head lba_map_list;
276         spinlock_t tg_pt_gps_lock;
277         struct se_device *t10_dev;
278         /* Used for default ALUA Target Port Group */
279         struct t10_alua_tg_pt_gp *default_tg_pt_gp;
280         /* Used for default ALUA Target Port Group ConfigFS group */
281         struct config_group alua_tg_pt_gps_group;
282         struct list_head tg_pt_gps_list;
283 };
284
285 struct t10_alua_lu_gp {
286         u16     lu_gp_id;
287         int     lu_gp_valid_id;
288         u32     lu_gp_members;
289         atomic_t lu_gp_ref_cnt;
290         spinlock_t lu_gp_lock;
291         struct config_group lu_gp_group;
292         struct list_head lu_gp_node;
293         struct list_head lu_gp_mem_list;
294 };
295
296 struct t10_alua_lu_gp_member {
297         bool lu_gp_assoc;
298         atomic_t lu_gp_mem_ref_cnt;
299         spinlock_t lu_gp_mem_lock;
300         struct t10_alua_lu_gp *lu_gp;
301         struct se_device *lu_gp_mem_dev;
302         struct list_head lu_gp_mem_list;
303 };
304
305 struct t10_alua_tg_pt_gp {
306         u16     tg_pt_gp_id;
307         int     tg_pt_gp_valid_id;
308         int     tg_pt_gp_alua_supported_states;
309         int     tg_pt_gp_alua_pending_state;
310         int     tg_pt_gp_alua_previous_state;
311         int     tg_pt_gp_alua_access_status;
312         int     tg_pt_gp_alua_access_type;
313         int     tg_pt_gp_nonop_delay_msecs;
314         int     tg_pt_gp_trans_delay_msecs;
315         int     tg_pt_gp_implicit_trans_secs;
316         int     tg_pt_gp_pref;
317         int     tg_pt_gp_write_metadata;
318         u32     tg_pt_gp_members;
319         atomic_t tg_pt_gp_alua_access_state;
320         atomic_t tg_pt_gp_ref_cnt;
321         spinlock_t tg_pt_gp_lock;
322         struct mutex tg_pt_gp_md_mutex;
323         struct se_device *tg_pt_gp_dev;
324         struct config_group tg_pt_gp_group;
325         struct list_head tg_pt_gp_list;
326         struct list_head tg_pt_gp_mem_list;
327         struct se_port *tg_pt_gp_alua_port;
328         struct se_node_acl *tg_pt_gp_alua_nacl;
329         struct delayed_work tg_pt_gp_transition_work;
330         struct completion *tg_pt_gp_transition_complete;
331 };
332
333 struct t10_alua_tg_pt_gp_member {
334         bool tg_pt_gp_assoc;
335         atomic_t tg_pt_gp_mem_ref_cnt;
336         spinlock_t tg_pt_gp_mem_lock;
337         struct t10_alua_tg_pt_gp *tg_pt_gp;
338         struct se_port *tg_pt;
339         struct list_head tg_pt_gp_mem_list;
340 };
341
342 struct t10_vpd {
343         unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
344         int protocol_identifier_set;
345         u32 protocol_identifier;
346         u32 device_identifier_code_set;
347         u32 association;
348         u32 device_identifier_type;
349         struct list_head vpd_list;
350 };
351
352 struct t10_wwn {
353         char vendor[8];
354         char model[16];
355         char revision[4];
356         char unit_serial[INQUIRY_VPD_SERIAL_LEN];
357         spinlock_t t10_vpd_lock;
358         struct se_device *t10_dev;
359         struct config_group t10_wwn_group;
360         struct list_head t10_vpd_list;
361 };
362
363 struct t10_pr_registration {
364         /* Used for fabrics that contain WWN+ISID */
365 #define PR_REG_ISID_LEN                         16
366         /* PR_REG_ISID_LEN + ',i,0x' */
367 #define PR_REG_ISID_ID_LEN                      (PR_REG_ISID_LEN + 5)
368         char pr_reg_isid[PR_REG_ISID_LEN];
369         /* Used during APTPL metadata reading */
370 #define PR_APTPL_MAX_IPORT_LEN                  256
371         unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
372         /* Used during APTPL metadata reading */
373 #define PR_APTPL_MAX_TPORT_LEN                  256
374         unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
375         u16 pr_aptpl_rpti;
376         u16 pr_reg_tpgt;
377         /* Reservation effects all target ports */
378         int pr_reg_all_tg_pt;
379         /* Activate Persistence across Target Power Loss */
380         int pr_reg_aptpl;
381         int pr_res_holder;
382         int pr_res_type;
383         int pr_res_scope;
384         /* Used for fabric initiator WWPNs using a ISID */
385         bool isid_present_at_reg;
386         u32 pr_res_mapped_lun;
387         u32 pr_aptpl_target_lun;
388         u32 pr_res_generation;
389         u64 pr_reg_bin_isid;
390         u64 pr_res_key;
391         atomic_t pr_res_holders;
392         struct se_node_acl *pr_reg_nacl;
393         struct se_dev_entry *pr_reg_deve;
394         struct se_lun *pr_reg_tg_pt_lun;
395         struct list_head pr_reg_list;
396         struct list_head pr_reg_abort_list;
397         struct list_head pr_reg_aptpl_list;
398         struct list_head pr_reg_atp_list;
399         struct list_head pr_reg_atp_mem_list;
400 };
401
402 struct t10_reservation {
403         /* Reservation effects all target ports */
404         int pr_all_tg_pt;
405         /* Activate Persistence across Target Power Loss enabled
406          * for SCSI device */
407         int pr_aptpl_active;
408 #define PR_APTPL_BUF_LEN                        262144
409         u32 pr_generation;
410         spinlock_t registration_lock;
411         spinlock_t aptpl_reg_lock;
412         /*
413          * This will always be set by one individual I_T Nexus.
414          * However with all_tg_pt=1, other I_T Nexus from the
415          * same initiator can access PR reg/res info on a different
416          * target port.
417          *
418          * There is also the 'All Registrants' case, where there is
419          * a single *pr_res_holder of the reservation, but all
420          * registrations are considered reservation holders.
421          */
422         struct se_node_acl *pr_res_holder;
423         struct list_head registration_list;
424         struct list_head aptpl_reg_list;
425 };
426
427 struct se_tmr_req {
428         /* Task Management function to be performed */
429         u8                      function;
430         /* Task Management response to send */
431         u8                      response;
432         int                     call_transport;
433         /* Reference to ITT that Task Mgmt should be performed */
434         u32                     ref_task_tag;
435         void                    *fabric_tmr_ptr;
436         struct se_cmd           *task_cmd;
437         struct se_device        *tmr_dev;
438         struct se_lun           *tmr_lun;
439         struct list_head        tmr_list;
440 };
441
442 enum target_prot_op {
443         TARGET_PROT_NORMAL      = 0,
444         TARGET_PROT_DIN_INSERT  = (1 << 0),
445         TARGET_PROT_DOUT_INSERT = (1 << 1),
446         TARGET_PROT_DIN_STRIP   = (1 << 2),
447         TARGET_PROT_DOUT_STRIP  = (1 << 3),
448         TARGET_PROT_DIN_PASS    = (1 << 4),
449         TARGET_PROT_DOUT_PASS   = (1 << 5),
450 };
451
452 #define TARGET_PROT_ALL TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \
453                         TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \
454                         TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS
455
456 enum target_prot_type {
457         TARGET_DIF_TYPE0_PROT,
458         TARGET_DIF_TYPE1_PROT,
459         TARGET_DIF_TYPE2_PROT,
460         TARGET_DIF_TYPE3_PROT,
461 };
462
463 enum target_core_dif_check {
464         TARGET_DIF_CHECK_GUARD  = 0x1 << 0,
465         TARGET_DIF_CHECK_APPTAG = 0x1 << 1,
466         TARGET_DIF_CHECK_REFTAG = 0x1 << 2,
467 };
468
469 struct se_dif_v1_tuple {
470         __be16                  guard_tag;
471         __be16                  app_tag;
472         __be32                  ref_tag;
473 };
474
475 /* for sam_task_attr */
476 #define TCM_SIMPLE_TAG  0x20
477 #define TCM_HEAD_TAG    0x21
478 #define TCM_ORDERED_TAG 0x22
479 #define TCM_ACA_TAG     0x24
480
481 struct se_cmd {
482         /* SAM response code being sent to initiator */
483         u8                      scsi_status;
484         u8                      scsi_asc;
485         u8                      scsi_ascq;
486         u16                     scsi_sense_length;
487         /* Delay for ALUA Active/NonOptimized state access in milliseconds */
488         int                     alua_nonop_delay;
489         /* See include/linux/dma-mapping.h */
490         enum dma_data_direction data_direction;
491         /* For SAM Task Attribute */
492         int                     sam_task_attr;
493         /* Used for se_sess->sess_tag_pool */
494         unsigned int            map_tag;
495         /* Transport protocol dependent state, see transport_state_table */
496         enum transport_state_table t_state;
497         unsigned                cmd_wait_set:1;
498         unsigned                unknown_data_length:1;
499         /* See se_cmd_flags_table */
500         u32                     se_cmd_flags;
501         u32                     se_ordered_id;
502         /* Total size in bytes associated with command */
503         u32                     data_length;
504         u32                     residual_count;
505         u32                     orig_fe_lun;
506         /* Persistent Reservation key */
507         u64                     pr_res_key;
508         /* Used for sense data */
509         void                    *sense_buffer;
510         struct list_head        se_delayed_node;
511         struct list_head        se_qf_node;
512         struct se_device      *se_dev;
513         struct se_dev_entry   *se_deve;
514         struct se_lun           *se_lun;
515         /* Only used for internal passthrough and legacy TCM fabric modules */
516         struct se_session       *se_sess;
517         struct se_tmr_req       *se_tmr_req;
518         struct list_head        se_cmd_list;
519         struct completion       cmd_wait_comp;
520         struct kref             cmd_kref;
521         const struct target_core_fabric_ops *se_tfo;
522         sense_reason_t          (*execute_cmd)(struct se_cmd *);
523         sense_reason_t          (*execute_rw)(struct se_cmd *, struct scatterlist *,
524                                               u32, enum dma_data_direction);
525         sense_reason_t (*transport_complete_callback)(struct se_cmd *, bool);
526
527         unsigned char           *t_task_cdb;
528         unsigned char           __t_task_cdb[TCM_MAX_COMMAND_SIZE];
529         unsigned long long      t_task_lba;
530         unsigned int            t_task_nolb;
531         unsigned int            transport_state;
532 #define CMD_T_ABORTED           (1 << 0)
533 #define CMD_T_ACTIVE            (1 << 1)
534 #define CMD_T_COMPLETE          (1 << 2)
535 #define CMD_T_SENT              (1 << 4)
536 #define CMD_T_STOP              (1 << 5)
537 #define CMD_T_DEV_ACTIVE        (1 << 7)
538 #define CMD_T_REQUEST_STOP      (1 << 8)
539 #define CMD_T_BUSY              (1 << 9)
540         spinlock_t              t_state_lock;
541         struct completion       t_transport_stop_comp;
542
543         struct work_struct      work;
544
545         struct scatterlist      *t_data_sg;
546         struct scatterlist      *t_data_sg_orig;
547         unsigned int            t_data_nents;
548         unsigned int            t_data_nents_orig;
549         void                    *t_data_vmap;
550         struct scatterlist      *t_bidi_data_sg;
551         unsigned int            t_bidi_data_nents;
552
553         struct list_head        state_list;
554         bool                    state_active;
555
556         /* old task stop completion, consider merging with some of the above */
557         struct completion       task_stop_comp;
558
559         /* backend private data */
560         void                    *priv;
561
562         /* Used for lun->lun_ref counting */
563         int                     lun_ref_active;
564
565         /* DIF related members */
566         enum target_prot_op     prot_op;
567         enum target_prot_type   prot_type;
568         u8                      prot_checks;
569         u32                     prot_length;
570         u32                     reftag_seed;
571         struct scatterlist      *t_prot_sg;
572         unsigned int            t_prot_nents;
573         sense_reason_t          pi_err;
574         sector_t                bad_sector;
575         bool                    prot_pto;
576 };
577
578 struct se_ua {
579         u8                      ua_asc;
580         u8                      ua_ascq;
581         struct se_node_acl      *ua_nacl;
582         struct list_head        ua_nacl_list;
583 };
584
585 struct se_node_acl {
586         char                    initiatorname[TRANSPORT_IQN_LEN];
587         /* Used to signal demo mode created ACL, disabled by default */
588         bool                    dynamic_node_acl;
589         bool                    acl_stop:1;
590         u32                     queue_depth;
591         u32                     acl_index;
592         enum target_prot_type   saved_prot_type;
593 #define MAX_ACL_TAG_SIZE 64
594         char                    acl_tag[MAX_ACL_TAG_SIZE];
595         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
596         atomic_t                acl_pr_ref_count;
597         struct se_dev_entry     **device_list;
598         struct se_session       *nacl_sess;
599         struct se_portal_group *se_tpg;
600         spinlock_t              device_list_lock;
601         spinlock_t              nacl_sess_lock;
602         struct config_group     acl_group;
603         struct config_group     acl_attrib_group;
604         struct config_group     acl_auth_group;
605         struct config_group     acl_param_group;
606         struct config_group     acl_fabric_stat_group;
607         struct config_group     *acl_default_groups[5];
608         struct list_head        acl_list;
609         struct list_head        acl_sess_list;
610         struct completion       acl_free_comp;
611         struct kref             acl_kref;
612 };
613
614 struct se_session {
615         unsigned                sess_tearing_down:1;
616         u64                     sess_bin_isid;
617         enum target_prot_op     sup_prot_ops;
618         enum target_prot_type   sess_prot_type;
619         struct se_node_acl      *se_node_acl;
620         struct se_portal_group *se_tpg;
621         void                    *fabric_sess_ptr;
622         struct list_head        sess_list;
623         struct list_head        sess_acl_list;
624         struct list_head        sess_cmd_list;
625         struct list_head        sess_wait_list;
626         spinlock_t              sess_cmd_lock;
627         struct kref             sess_kref;
628         void                    *sess_cmd_map;
629         struct percpu_ida       sess_tag_pool;
630 };
631
632 struct se_device;
633 struct se_transform_info;
634 struct scatterlist;
635
636 struct se_ml_stat_grps {
637         struct config_group     stat_group;
638         struct config_group     scsi_auth_intr_group;
639         struct config_group     scsi_att_intr_port_group;
640 };
641
642 struct se_lun_acl {
643         char                    initiatorname[TRANSPORT_IQN_LEN];
644         u32                     mapped_lun;
645         struct se_node_acl      *se_lun_nacl;
646         struct se_lun           *se_lun;
647         struct list_head        lacl_list;
648         struct config_group     se_lun_group;
649         struct se_ml_stat_grps  ml_stat_grps;
650 };
651
652 struct se_dev_entry {
653         bool                    def_pr_registered;
654         /* See transport_lunflags_table */
655         u32                     lun_flags;
656         u32                     mapped_lun;
657         u32                     total_cmds;
658         u64                     pr_res_key;
659         u64                     creation_time;
660         u32                     attach_count;
661         u64                     read_bytes;
662         u64                     write_bytes;
663         atomic_t                ua_count;
664         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
665         atomic_t                pr_ref_count;
666         struct se_lun_acl       *se_lun_acl;
667         spinlock_t              ua_lock;
668         struct se_lun           *se_lun;
669         struct list_head        alua_port_list;
670         struct list_head        ua_list;
671 };
672
673 struct se_dev_attrib {
674         int             emulate_model_alias;
675         int             emulate_dpo;
676         int             emulate_fua_write;
677         int             emulate_fua_read;
678         int             emulate_write_cache;
679         int             emulate_ua_intlck_ctrl;
680         int             emulate_tas;
681         int             emulate_tpu;
682         int             emulate_tpws;
683         int             emulate_caw;
684         int             emulate_3pc;
685         int             pi_prot_format;
686         enum target_prot_type pi_prot_type;
687         enum target_prot_type hw_pi_prot_type;
688         int             enforce_pr_isids;
689         int             force_pr_aptpl;
690         int             is_nonrot;
691         int             emulate_rest_reord;
692         u32             hw_block_size;
693         u32             block_size;
694         u32             hw_max_sectors;
695         u32             optimal_sectors;
696         u32             hw_queue_depth;
697         u32             queue_depth;
698         u32             max_unmap_lba_count;
699         u32             max_unmap_block_desc_count;
700         u32             unmap_granularity;
701         u32             unmap_granularity_alignment;
702         u32             max_write_same_len;
703         u32             max_bytes_per_io;
704         struct se_device *da_dev;
705         struct config_group da_group;
706 };
707
708 struct se_port_stat_grps {
709         struct config_group stat_group;
710         struct config_group scsi_port_group;
711         struct config_group scsi_tgt_port_group;
712         struct config_group scsi_transport_group;
713 };
714
715 struct se_lun {
716 #define SE_LUN_LINK_MAGIC                       0xffff7771
717         u32                     lun_link_magic;
718         /* See transport_lun_status_table */
719         enum transport_lun_status_table lun_status;
720         u32                     lun_access;
721         u32                     lun_flags;
722         u32                     unpacked_lun;
723         atomic_t                lun_acl_count;
724         spinlock_t              lun_acl_lock;
725         spinlock_t              lun_sep_lock;
726         struct completion       lun_shutdown_comp;
727         struct list_head        lun_acl_list;
728         struct se_device        *lun_se_dev;
729         struct se_port          *lun_sep;
730         struct config_group     lun_group;
731         struct se_port_stat_grps port_stat_grps;
732         struct completion       lun_ref_comp;
733         struct percpu_ref       lun_ref;
734 };
735
736 struct se_dev_stat_grps {
737         struct config_group stat_group;
738         struct config_group scsi_dev_group;
739         struct config_group scsi_tgt_dev_group;
740         struct config_group scsi_lu_group;
741 };
742
743 struct se_device {
744 #define SE_DEV_LINK_MAGIC                       0xfeeddeef
745         u32                     dev_link_magic;
746         /* RELATIVE TARGET PORT IDENTIFER Counter */
747         u16                     dev_rpti_counter;
748         /* Used for SAM Task Attribute ordering */
749         u32                     dev_cur_ordered_id;
750         u32                     dev_flags;
751 #define DF_CONFIGURED                           0x00000001
752 #define DF_FIRMWARE_VPD_UNIT_SERIAL             0x00000002
753 #define DF_EMULATED_VPD_UNIT_SERIAL             0x00000004
754 #define DF_USING_UDEV_PATH                      0x00000008
755 #define DF_USING_ALIAS                          0x00000010
756         u32                     dev_port_count;
757         /* Physical device queue depth */
758         u32                     queue_depth;
759         /* Used for SPC-2 reservations enforce of ISIDs */
760         u64                     dev_res_bin_isid;
761         /* Pointer to transport specific device structure */
762         u32                     dev_index;
763         u64                     creation_time;
764         atomic_long_t           num_resets;
765         atomic_long_t           num_cmds;
766         atomic_long_t           read_bytes;
767         atomic_long_t           write_bytes;
768         /* Active commands on this virtual SE device */
769         atomic_t                simple_cmds;
770         atomic_t                dev_ordered_id;
771         atomic_t                dev_ordered_sync;
772         atomic_t                dev_qf_count;
773         int                     export_count;
774         spinlock_t              delayed_cmd_lock;
775         spinlock_t              execute_task_lock;
776         spinlock_t              dev_reservation_lock;
777         unsigned int            dev_reservation_flags;
778 #define DRF_SPC2_RESERVATIONS                   0x00000001
779 #define DRF_SPC2_RESERVATIONS_WITH_ISID         0x00000002
780         spinlock_t              se_port_lock;
781         spinlock_t              se_tmr_lock;
782         spinlock_t              qf_cmd_lock;
783         struct semaphore        caw_sem;
784         /* Used for legacy SPC-2 reservationsa */
785         struct se_node_acl      *dev_reserved_node_acl;
786         /* Used for ALUA Logical Unit Group membership */
787         struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
788         /* Used for SPC-3 Persistent Reservations */
789         struct t10_pr_registration *dev_pr_res_holder;
790         struct list_head        dev_sep_list;
791         struct list_head        dev_tmr_list;
792         struct workqueue_struct *tmr_wq;
793         struct work_struct      qf_work_queue;
794         struct list_head        delayed_cmd_list;
795         struct list_head        state_list;
796         struct list_head        qf_cmd_list;
797         struct list_head        g_dev_node;
798         /* Pointer to associated SE HBA */
799         struct se_hba           *se_hba;
800         /* T10 Inquiry and VPD WWN Information */
801         struct t10_wwn          t10_wwn;
802         /* T10 Asymmetric Logical Unit Assignment for Target Ports */
803         struct t10_alua         t10_alua;
804         /* T10 SPC-2 + SPC-3 Reservations */
805         struct t10_reservation  t10_pr;
806         struct se_dev_attrib    dev_attrib;
807         struct config_group     dev_group;
808         struct config_group     dev_pr_group;
809         struct se_dev_stat_grps dev_stat_grps;
810 #define SE_DEV_ALIAS_LEN 512            /* must be less than PAGE_SIZE */
811         unsigned char           dev_alias[SE_DEV_ALIAS_LEN];
812 #define SE_UDEV_PATH_LEN 512            /* must be less than PAGE_SIZE */
813         unsigned char           udev_path[SE_UDEV_PATH_LEN];
814         /* Pointer to template of function pointers for transport */
815         struct se_subsystem_api *transport;
816         /* Linked list for struct se_hba struct se_device list */
817         struct list_head        dev_list;
818         struct se_lun           xcopy_lun;
819         /* Protection Information */
820         int                     prot_length;
821 };
822
823 struct se_hba {
824         u16                     hba_tpgt;
825         u32                     hba_id;
826         /* See hba_flags_table */
827         u32                     hba_flags;
828         /* Virtual iSCSI devices attached. */
829         u32                     dev_count;
830         u32                     hba_index;
831         /* Pointer to transport specific host structure. */
832         void                    *hba_ptr;
833         struct list_head        hba_node;
834         spinlock_t              device_lock;
835         struct config_group     hba_group;
836         struct mutex            hba_access_mutex;
837         struct se_subsystem_api *transport;
838 };
839
840 struct scsi_port_stats {
841        u64     cmd_pdus;
842        u64     tx_data_octets;
843        u64     rx_data_octets;
844 };
845
846 struct se_port {
847         /* RELATIVE TARGET PORT IDENTIFER */
848         u16             sep_rtpi;
849         int             sep_tg_pt_secondary_stat;
850         int             sep_tg_pt_secondary_write_md;
851         u32             sep_index;
852         struct scsi_port_stats sep_stats;
853         /* Used for ALUA Target Port Groups membership */
854         atomic_t        sep_tg_pt_secondary_offline;
855         /* Used for PR ALL_TG_PT=1 */
856         atomic_t        sep_tg_pt_ref_cnt;
857         spinlock_t      sep_alua_lock;
858         struct mutex    sep_tg_pt_md_mutex;
859         struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
860         struct se_lun *sep_lun;
861         struct se_portal_group *sep_tpg;
862         struct list_head sep_alua_list;
863         struct list_head sep_list;
864 };
865
866 struct se_tpg_np {
867         struct se_portal_group *tpg_np_parent;
868         struct config_group     tpg_np_group;
869 };
870
871 struct se_portal_group {
872         /* Type of target portal group, see transport_tpg_type_table */
873         enum transport_tpg_type_table se_tpg_type;
874         /* Number of ACLed Initiator Nodes for this TPG */
875         u32                     num_node_acls;
876         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
877         atomic_t                tpg_pr_ref_count;
878         /* Spinlock for adding/removing ACLed Nodes */
879         spinlock_t              acl_node_lock;
880         /* Spinlock for adding/removing sessions */
881         spinlock_t              session_lock;
882         spinlock_t              tpg_lun_lock;
883         /* Pointer to $FABRIC_MOD portal group */
884         void                    *se_tpg_fabric_ptr;
885         struct list_head        se_tpg_node;
886         /* linked list for initiator ACL list */
887         struct list_head        acl_node_list;
888         struct se_lun           **tpg_lun_list;
889         struct se_lun           tpg_virt_lun0;
890         /* List of TCM sessions associated wth this TPG */
891         struct list_head        tpg_sess_list;
892         /* Pointer to $FABRIC_MOD dependent code */
893         const struct target_core_fabric_ops *se_tpg_tfo;
894         struct se_wwn           *se_tpg_wwn;
895         struct config_group     tpg_group;
896         struct config_group     *tpg_default_groups[7];
897         struct config_group     tpg_lun_group;
898         struct config_group     tpg_np_group;
899         struct config_group     tpg_acl_group;
900         struct config_group     tpg_attrib_group;
901         struct config_group     tpg_auth_group;
902         struct config_group     tpg_param_group;
903 };
904
905 struct se_wwn {
906         struct target_fabric_configfs *wwn_tf;
907         struct config_group     wwn_group;
908         struct config_group     *wwn_default_groups[2];
909         struct config_group     fabric_stat_group;
910 };
911
912 static inline void atomic_inc_mb(atomic_t *v)
913 {
914         smp_mb__before_atomic();
915         atomic_inc(v);
916         smp_mb__after_atomic();
917 }
918
919 static inline void atomic_dec_mb(atomic_t *v)
920 {
921         smp_mb__before_atomic();
922         atomic_dec(v);
923         smp_mb__after_atomic();
924 }
925
926 #endif /* TARGET_CORE_BASE_H */