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