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