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