include/target/target_core_base.h

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