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 for target SCSI statistics
 237  */
 238 typedef enum {
 239         SCSI_INST_INDEX,
 240         SCSI_DEVICE_INDEX,
 241         SCSI_AUTH_INTR_INDEX,
 242         SCSI_INDEX_TYPE_MAX
 243 } scsi_index_t;
 244
 245 struct se_cmd;
 246
 247 struct t10_alua {
 248         t10_alua_index_t alua_type;
 249         /* ALUA Target Port Group ID */
 250         u16     alua_tg_pt_gps_counter;
 251         u32     alua_tg_pt_gps_count;
 252         spinlock_t tg_pt_gps_lock;
 253         struct se_device *t10_dev;
 254         /* Used for default ALUA Target Port Group */
 255         struct t10_alua_tg_pt_gp *default_tg_pt_gp;
 256         /* Used for default ALUA Target Port Group ConfigFS group */
 257         struct config_group alua_tg_pt_gps_group;
 258         int (*alua_state_check)(struct se_cmd *, unsigned char *, u8 *);
 259         struct list_head tg_pt_gps_list;
 260 };
 261
 262 struct t10_alua_lu_gp {
 263         u16     lu_gp_id;
 264         int     lu_gp_valid_id;
 265         u32     lu_gp_members;
 266         atomic_t lu_gp_ref_cnt;
 267         spinlock_t lu_gp_lock;
 268         struct config_group lu_gp_group;
 269         struct list_head lu_gp_node;
 270         struct list_head lu_gp_mem_list;
 271 };
 272
 273 struct t10_alua_lu_gp_member {
 274         bool lu_gp_assoc;
 275         atomic_t lu_gp_mem_ref_cnt;
 276         spinlock_t lu_gp_mem_lock;
 277         struct t10_alua_lu_gp *lu_gp;
 278         struct se_device *lu_gp_mem_dev;
 279         struct list_head lu_gp_mem_list;
 280 };
 281
 282 struct t10_alua_tg_pt_gp {
 283         u16     tg_pt_gp_id;
 284         int     tg_pt_gp_valid_id;
 285         int     tg_pt_gp_alua_access_status;
 286         int     tg_pt_gp_alua_access_type;
 287         int     tg_pt_gp_nonop_delay_msecs;
 288         int     tg_pt_gp_trans_delay_msecs;
 289         int     tg_pt_gp_implict_trans_secs;
 290         int     tg_pt_gp_pref;
 291         int     tg_pt_gp_write_metadata;
 292         /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
 293 #define ALUA_MD_BUF_LEN                         1024
 294         u32     tg_pt_gp_md_buf_len;
 295         u32     tg_pt_gp_members;
 296         atomic_t tg_pt_gp_alua_access_state;
 297         atomic_t tg_pt_gp_ref_cnt;
 298         spinlock_t tg_pt_gp_lock;
 299         struct mutex tg_pt_gp_md_mutex;
 300         struct se_device *tg_pt_gp_dev;
 301         struct config_group tg_pt_gp_group;
 302         struct list_head tg_pt_gp_list;
 303         struct list_head tg_pt_gp_mem_list;
 304 };
 305
 306 struct t10_alua_tg_pt_gp_member {
 307         bool tg_pt_gp_assoc;
 308         atomic_t tg_pt_gp_mem_ref_cnt;
 309         spinlock_t tg_pt_gp_mem_lock;
 310         struct t10_alua_tg_pt_gp *tg_pt_gp;
 311         struct se_port *tg_pt;
 312         struct list_head tg_pt_gp_mem_list;
 313 };
 314
 315 struct t10_vpd {
 316         unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
 317         int protocol_identifier_set;
 318         u32 protocol_identifier;
 319         u32 device_identifier_code_set;
 320         u32 association;
 321         u32 device_identifier_type;
 322         struct list_head vpd_list;
 323 };
 324
 325 struct t10_wwn {
 326         char vendor[8];
 327         char model[16];
 328         char revision[4];
 329         char unit_serial[INQUIRY_VPD_SERIAL_LEN];
 330         spinlock_t t10_vpd_lock;
 331         struct se_device *t10_dev;
 332         struct config_group t10_wwn_group;
 333         struct list_head t10_vpd_list;
 334 };
 335
 336
 337 /*
 338  * Used by TCM Core internally to signal if >= SPC-3 persistent reservations
 339  * emulation is enabled or disabled, or running in with TCM/pSCSI passthrough
 340  * mode
 341  */
 342 typedef enum {
 343         SPC_PASSTHROUGH,
 344         SPC2_RESERVATIONS,
 345         SPC3_PERSISTENT_RESERVATIONS
 346 } t10_reservations_index_t;
 347
 348 struct t10_pr_registration {
 349         /* Used for fabrics that contain WWN+ISID */
 350 #define PR_REG_ISID_LEN                         16
 351         /* PR_REG_ISID_LEN + ',i,0x' */
 352 #define PR_REG_ISID_ID_LEN                      (PR_REG_ISID_LEN + 5)
 353         char pr_reg_isid[PR_REG_ISID_LEN];
 354         /* Used during APTPL metadata reading */
 355 #define PR_APTPL_MAX_IPORT_LEN                  256
 356         unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
 357         /* Used during APTPL metadata reading */
 358 #define PR_APTPL_MAX_TPORT_LEN                  256
 359         unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
 360         /* For writing out live meta data */
 361         unsigned char *pr_aptpl_buf;
 362         u16 pr_aptpl_rpti;
 363         u16 pr_reg_tpgt;
 364         /* Reservation effects all target ports */
 365         int pr_reg_all_tg_pt;
 366         /* Activate Persistence across Target Power Loss */
 367         int pr_reg_aptpl;
 368         int pr_res_holder;
 369         int pr_res_type;
 370         int pr_res_scope;
 371         /* Used for fabric initiator WWPNs using a ISID */
 372         bool isid_present_at_reg;
 373         u32 pr_res_mapped_lun;
 374         u32 pr_aptpl_target_lun;
 375         u32 pr_res_generation;
 376         u64 pr_reg_bin_isid;
 377         u64 pr_res_key;
 378         atomic_t pr_res_holders;
 379         struct se_node_acl *pr_reg_nacl;
 380         struct se_dev_entry *pr_reg_deve;
 381         struct se_lun *pr_reg_tg_pt_lun;
 382         struct list_head pr_reg_list;
 383         struct list_head pr_reg_abort_list;
 384         struct list_head pr_reg_aptpl_list;
 385         struct list_head pr_reg_atp_list;
 386         struct list_head pr_reg_atp_mem_list;
 387 };
 388
 389 /*
 390  * This set of function pointer ops is set based upon SPC3_PERSISTENT_RESERVATIONS,
 391  * SPC2_RESERVATIONS or SPC_PASSTHROUGH in drivers/target/target_core_pr.c:
 392  * core_setup_reservations()
 393  */
 394 struct t10_reservation_ops {
 395         int (*t10_reservation_check)(struct se_cmd *, u32 *);
 396         int (*t10_seq_non_holder)(struct se_cmd *, unsigned char *, u32);
 397         int (*t10_pr_register)(struct se_cmd *);
 398         int (*t10_pr_clear)(struct se_cmd *);
 399 };
 400
 401 struct t10_reservation {
 402         /* Reservation effects all target ports */
 403         int pr_all_tg_pt;
 404         /* Activate Persistence across Target Power Loss enabled
 405          * for SCSI device */
 406         int pr_aptpl_active;
 407         /* Used by struct t10_reservation->pr_aptpl_buf_len */
 408 #define PR_APTPL_BUF_LEN                        8192
 409         u32 pr_aptpl_buf_len;
 410         u32 pr_generation;
 411         t10_reservations_index_t res_type;
 412         spinlock_t registration_lock;
 413         spinlock_t aptpl_reg_lock;
 414         /*
 415          * This will always be set by one individual I_T Nexus.
 416          * However with all_tg_pt=1, other I_T Nexus from the
 417          * same initiator can access PR reg/res info on a different
 418          * target port.
 419          *
 420          * There is also the 'All Registrants' case, where there is
 421          * a single *pr_res_holder of the reservation, but all
 422          * registrations are considered reservation holders.
 423          */
 424         struct se_node_acl *pr_res_holder;
 425         struct list_head registration_list;
 426         struct list_head aptpl_reg_list;
 427         struct t10_reservation_ops pr_ops;
 428 };
 429
 430 struct se_tmr_req {
 431         /* Task Management function to be performed */
 432         u8                      function;
 433         /* Task Management response to send */
 434         u8                      response;
 435         int                     call_transport;
 436         /* Reference to ITT that Task Mgmt should be performed */
 437         u32                     ref_task_tag;
 438         void                    *fabric_tmr_ptr;
 439         struct se_cmd           *task_cmd;
 440         struct se_device        *tmr_dev;
 441         struct se_lun           *tmr_lun;
 442         struct list_head        tmr_list;
 443 };
 444
 445 struct se_cmd {
 446         /* SAM response code being sent to initiator */
 447         u8                      scsi_status;
 448         u8                      scsi_asc;
 449         u8                      scsi_ascq;
 450         u8                      scsi_sense_reason;
 451         u16                     scsi_sense_length;
 452         /* Delay for ALUA Active/NonOptimized state access in milliseconds */
 453         int                     alua_nonop_delay;
 454         /* See include/linux/dma-mapping.h */
 455         enum dma_data_direction data_direction;
 456         /* For SAM Task Attribute */
 457         int                     sam_task_attr;
 458         /* Transport protocol dependent state, see transport_state_table */
 459         enum transport_state_table t_state;
 460         /* Used to signal cmd->se_tfo->check_release_cmd() usage per cmd */
 461         unsigned                check_release:1;
 462         unsigned                cmd_wait_set:1;
 463         unsigned                unknown_data_length:1;
 464         /* See se_cmd_flags_table */
 465         u32                     se_cmd_flags;
 466         u32                     se_ordered_id;
 467         /* Total size in bytes associated with command */
 468         u32                     data_length;
 469         u32                     residual_count;
 470         u32                     orig_fe_lun;
 471         /* Persistent Reservation key */
 472         u64                     pr_res_key;
 473         /* Used for sense data */
 474         void                    *sense_buffer;
 475         struct list_head        se_delayed_node;
 476         struct list_head        se_lun_node;
 477         struct list_head        se_qf_node;
 478         struct se_device      *se_dev;
 479         struct se_dev_entry   *se_deve;
 480         struct se_lun           *se_lun;
 481         /* Only used for internal passthrough and legacy TCM fabric modules */
 482         struct se_session       *se_sess;
 483         struct se_tmr_req       *se_tmr_req;
 484         struct list_head        se_cmd_list;
 485         struct completion       cmd_wait_comp;
 486         struct kref             cmd_kref;
 487         struct target_core_fabric_ops *se_tfo;
 488         int (*execute_cmd)(struct se_cmd *);
 489         void (*transport_complete_callback)(struct se_cmd *);
 490
 491         unsigned char           *t_task_cdb;
 492         unsigned char           __t_task_cdb[TCM_MAX_COMMAND_SIZE];
 493         unsigned long long      t_task_lba;
 494         atomic_t                t_fe_count;
 495         unsigned int            transport_state;
 496 #define CMD_T_ABORTED           (1 << 0)
 497 #define CMD_T_ACTIVE            (1 << 1)
 498 #define CMD_T_COMPLETE          (1 << 2)
 499 #define CMD_T_QUEUED            (1 << 3)
 500 #define CMD_T_SENT              (1 << 4)
 501 #define CMD_T_STOP              (1 << 5)
 502 #define CMD_T_FAILED            (1 << 6)
 503 #define CMD_T_LUN_STOP          (1 << 7)
 504 #define CMD_T_LUN_FE_STOP       (1 << 8)
 505 #define CMD_T_DEV_ACTIVE        (1 << 9)
 506 #define CMD_T_REQUEST_STOP      (1 << 10)
 507 #define CMD_T_BUSY              (1 << 11)
 508         spinlock_t              t_state_lock;
 509         struct completion       t_transport_stop_comp;
 510         struct completion       transport_lun_fe_stop_comp;
 511         struct completion       transport_lun_stop_comp;
 512
 513         struct work_struct      work;
 514
 515         struct scatterlist      *t_data_sg;
 516         unsigned int            t_data_nents;
 517         void                    *t_data_vmap;
 518         struct scatterlist      *t_bidi_data_sg;
 519         unsigned int            t_bidi_data_nents;
 520
 521         struct list_head        state_list;
 522         bool                    state_active;
 523
 524         /* old task stop completion, consider merging with some of the above */
 525         struct completion       task_stop_comp;
 526
 527         /* backend private data */
 528         void                    *priv;
 529 };
 530
 531 struct se_ua {
 532         u8                      ua_asc;
 533         u8                      ua_ascq;
 534         struct se_node_acl      *ua_nacl;
 535         struct list_head        ua_dev_list;
 536         struct list_head        ua_nacl_list;
 537 };
 538
 539 struct se_node_acl {
 540         char                    initiatorname[TRANSPORT_IQN_LEN];
 541         /* Used to signal demo mode created ACL, disabled by default */
 542         bool                    dynamic_node_acl;
 543         bool                    acl_stop:1;
 544         u32                     queue_depth;
 545         u32                     acl_index;
 546         u64                     num_cmds;
 547         u64                     read_bytes;
 548         u64                     write_bytes;
 549         spinlock_t              stats_lock;
 550         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 551         atomic_t                acl_pr_ref_count;
 552         struct se_dev_entry     **device_list;
 553         struct se_session       *nacl_sess;
 554         struct se_portal_group *se_tpg;
 555         spinlock_t              device_list_lock;
 556         spinlock_t              nacl_sess_lock;
 557         struct config_group     acl_group;
 558         struct config_group     acl_attrib_group;
 559         struct config_group     acl_auth_group;
 560         struct config_group     acl_param_group;
 561         struct config_group     acl_fabric_stat_group;
 562         struct config_group     *acl_default_groups[5];
 563         struct list_head        acl_list;
 564         struct list_head        acl_sess_list;
 565         struct completion       acl_free_comp;
 566         struct kref             acl_kref;
 567 };
 568
 569 struct se_session {
 570         unsigned                sess_tearing_down:1;
 571         u64                     sess_bin_isid;
 572         struct se_node_acl      *se_node_acl;
 573         struct se_portal_group *se_tpg;
 574         void                    *fabric_sess_ptr;
 575         struct list_head        sess_list;
 576         struct list_head        sess_acl_list;
 577         struct list_head        sess_cmd_list;
 578         spinlock_t              sess_cmd_lock;
 579         struct kref             sess_kref;
 580 };
 581
 582 struct se_device;
 583 struct se_transform_info;
 584 struct scatterlist;
 585
 586 struct se_ml_stat_grps {
 587         struct config_group     stat_group;
 588         struct config_group     scsi_auth_intr_group;
 589         struct config_group     scsi_att_intr_port_group;
 590 };
 591
 592 struct se_lun_acl {
 593         char                    initiatorname[TRANSPORT_IQN_LEN];
 594         u32                     mapped_lun;
 595         struct se_node_acl      *se_lun_nacl;
 596         struct se_lun           *se_lun;
 597         struct list_head        lacl_list;
 598         struct config_group     se_lun_group;
 599         struct se_ml_stat_grps  ml_stat_grps;
 600 };
 601
 602 struct se_dev_entry {
 603         bool                    def_pr_registered;
 604         /* See transport_lunflags_table */
 605         u32                     lun_flags;
 606         u32                     deve_cmds;
 607         u32                     mapped_lun;
 608         u32                     average_bytes;
 609         u32                     last_byte_count;
 610         u32                     total_cmds;
 611         u32                     total_bytes;
 612         u64                     pr_res_key;
 613         u64                     creation_time;
 614         u32                     attach_count;
 615         u64                     read_bytes;
 616         u64                     write_bytes;
 617         atomic_t                ua_count;
 618         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 619         atomic_t                pr_ref_count;
 620         struct se_lun_acl       *se_lun_acl;
 621         spinlock_t              ua_lock;
 622         struct se_lun           *se_lun;
 623         struct list_head        alua_port_list;
 624         struct list_head        ua_list;
 625 };
 626
 627 struct se_dev_attrib {
 628         int             emulate_dpo;
 629         int             emulate_fua_write;
 630         int             emulate_fua_read;
 631         int             emulate_write_cache;
 632         int             emulate_ua_intlck_ctrl;
 633         int             emulate_tas;
 634         int             emulate_tpu;
 635         int             emulate_tpws;
 636         int             emulate_reservations;
 637         int             emulate_alua;
 638         int             enforce_pr_isids;
 639         int             is_nonrot;
 640         int             emulate_rest_reord;
 641         u32             hw_block_size;
 642         u32             block_size;
 643         u32             hw_max_sectors;
 644         u32             fabric_max_sectors;
 645         u32             optimal_sectors;
 646         u32             hw_queue_depth;
 647         u32             queue_depth;
 648         u32             max_unmap_lba_count;
 649         u32             max_unmap_block_desc_count;
 650         u32             unmap_granularity;
 651         u32             unmap_granularity_alignment;
 652         struct se_device *da_dev;
 653         struct config_group da_group;
 654 };
 655
 656 struct se_dev_stat_grps {
 657         struct config_group stat_group;
 658         struct config_group scsi_dev_group;
 659         struct config_group scsi_tgt_dev_group;
 660         struct config_group scsi_lu_group;
 661 };
 662
 663 struct se_device {
 664         /* RELATIVE TARGET PORT IDENTIFER Counter */
 665         u16                     dev_rpti_counter;
 666         /* Used for SAM Task Attribute ordering */
 667         u32                     dev_cur_ordered_id;
 668         u32                     dev_flags;
 669 #define DF_CONFIGURED                           0x00000001
 670 #define DF_FIRMWARE_VPD_UNIT_SERIAL             0x00000002
 671 #define DF_EMULATED_VPD_UNIT_SERIAL             0x00000004
 672 #define DF_USING_UDEV_PATH                      0x00000008
 673 #define DF_USING_ALIAS                          0x00000010
 674         u32                     dev_port_count;
 675         /* Physical device queue depth */
 676         u32                     queue_depth;
 677         /* Used for SPC-2 reservations enforce of ISIDs */
 678         u64                     dev_res_bin_isid;
 679         /* Pointer to transport specific device structure */
 680         u32                     dev_index;
 681         u64                     creation_time;
 682         u32                     num_resets;
 683         u64                     num_cmds;
 684         u64                     read_bytes;
 685         u64                     write_bytes;
 686         spinlock_t              stats_lock;
 687         /* Active commands on this virtual SE device */
 688         atomic_t                simple_cmds;
 689         atomic_t                dev_ordered_id;
 690         atomic_t                dev_ordered_sync;
 691         atomic_t                dev_qf_count;
 692         int                     export_count;
 693         spinlock_t              delayed_cmd_lock;
 694         spinlock_t              execute_task_lock;
 695         spinlock_t              dev_reservation_lock;
 696         unsigned int            dev_reservation_flags;
 697 #define DRF_SPC2_RESERVATIONS                   0x00000001
 698 #define DRF_SPC2_RESERVATIONS_WITH_ISID         0x00000002
 699         spinlock_t              se_port_lock;
 700         spinlock_t              se_tmr_lock;
 701         spinlock_t              qf_cmd_lock;
 702         /* Used for legacy SPC-2 reservationsa */
 703         struct se_node_acl      *dev_reserved_node_acl;
 704         /* Used for ALUA Logical Unit Group membership */
 705         struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
 706         /* Used for SPC-3 Persistent Reservations */
 707         struct t10_pr_registration *dev_pr_res_holder;
 708         struct list_head        dev_sep_list;
 709         struct list_head        dev_tmr_list;
 710         struct workqueue_struct *tmr_wq;
 711         struct work_struct      qf_work_queue;
 712         struct list_head        delayed_cmd_list;
 713         struct list_head        state_list;
 714         struct list_head        qf_cmd_list;
 715         /* Pointer to associated SE HBA */
 716         struct se_hba           *se_hba;
 717         /* T10 Inquiry and VPD WWN Information */
 718         struct t10_wwn          t10_wwn;
 719         /* T10 Asymmetric Logical Unit Assignment for Target Ports */
 720         struct t10_alua         t10_alua;
 721         /* T10 SPC-2 + SPC-3 Reservations */
 722         struct t10_reservation  t10_pr;
 723         struct se_dev_attrib    dev_attrib;
 724         struct config_group     dev_group;
 725         struct config_group     dev_pr_group;
 726         struct se_dev_stat_grps dev_stat_grps;
 727 #define SE_DEV_ALIAS_LEN 512            /* must be less than PAGE_SIZE */
 728         unsigned char           dev_alias[SE_DEV_ALIAS_LEN];
 729 #define SE_UDEV_PATH_LEN 512            /* must be less than PAGE_SIZE */
 730         unsigned char           udev_path[SE_UDEV_PATH_LEN];
 731         /* Pointer to template of function pointers for transport */
 732         struct se_subsystem_api *transport;
 733         /* Linked list for struct se_hba struct se_device list */
 734         struct list_head        dev_list;
 735 };
 736
 737 struct se_hba {
 738         u16                     hba_tpgt;
 739         u32                     hba_id;
 740         /* See hba_flags_table */
 741         u32                     hba_flags;
 742         /* Virtual iSCSI devices attached. */
 743         u32                     dev_count;
 744         u32                     hba_index;
 745         /* Pointer to transport specific host structure. */
 746         void                    *hba_ptr;
 747         struct list_head        hba_node;
 748         spinlock_t              device_lock;
 749         struct config_group     hba_group;
 750         struct mutex            hba_access_mutex;
 751         struct se_subsystem_api *transport;
 752 };
 753
 754 struct se_port_stat_grps {
 755         struct config_group stat_group;
 756         struct config_group scsi_port_group;
 757         struct config_group scsi_tgt_port_group;
 758         struct config_group scsi_transport_group;
 759 };
 760
 761 struct se_lun {
 762         /* See transport_lun_status_table */
 763         enum transport_lun_status_table lun_status;
 764         u32                     lun_access;
 765         u32                     lun_flags;
 766         u32                     unpacked_lun;
 767         atomic_t                lun_acl_count;
 768         spinlock_t              lun_acl_lock;
 769         spinlock_t              lun_cmd_lock;
 770         spinlock_t              lun_sep_lock;
 771         struct completion       lun_shutdown_comp;
 772         struct list_head        lun_cmd_list;
 773         struct list_head        lun_acl_list;
 774         struct se_device        *lun_se_dev;
 775         struct se_port          *lun_sep;
 776         struct config_group     lun_group;
 777         struct se_port_stat_grps port_stat_grps;
 778 };
 779
 780 struct scsi_port_stats {
 781        u64     cmd_pdus;
 782        u64     tx_data_octets;
 783        u64     rx_data_octets;
 784 };
 785
 786 struct se_port {
 787         /* RELATIVE TARGET PORT IDENTIFER */
 788         u16             sep_rtpi;
 789         int             sep_tg_pt_secondary_stat;
 790         int             sep_tg_pt_secondary_write_md;
 791         u32             sep_index;
 792         struct scsi_port_stats sep_stats;
 793         /* Used for ALUA Target Port Groups membership */
 794         atomic_t        sep_tg_pt_secondary_offline;
 795         /* Used for PR ALL_TG_PT=1 */
 796         atomic_t        sep_tg_pt_ref_cnt;
 797         spinlock_t      sep_alua_lock;
 798         struct mutex    sep_tg_pt_md_mutex;
 799         struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
 800         struct se_lun *sep_lun;
 801         struct se_portal_group *sep_tpg;
 802         struct list_head sep_alua_list;
 803         struct list_head sep_list;
 804 };
 805
 806 struct se_tpg_np {
 807         struct se_portal_group *tpg_np_parent;
 808         struct config_group     tpg_np_group;
 809 };
 810
 811 struct se_portal_group {
 812         /* Type of target portal group, see transport_tpg_type_table */
 813         enum transport_tpg_type_table se_tpg_type;
 814         /* Number of ACLed Initiator Nodes for this TPG */
 815         u32                     num_node_acls;
 816         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 817         atomic_t                tpg_pr_ref_count;
 818         /* Spinlock for adding/removing ACLed Nodes */
 819         spinlock_t              acl_node_lock;
 820         /* Spinlock for adding/removing sessions */
 821         spinlock_t              session_lock;
 822         spinlock_t              tpg_lun_lock;
 823         /* Pointer to $FABRIC_MOD portal group */
 824         void                    *se_tpg_fabric_ptr;
 825         struct list_head        se_tpg_node;
 826         /* linked list for initiator ACL list */
 827         struct list_head        acl_node_list;
 828         struct se_lun           **tpg_lun_list;
 829         struct se_lun           tpg_virt_lun0;
 830         /* List of TCM sessions associated wth this TPG */
 831         struct list_head        tpg_sess_list;
 832         /* Pointer to $FABRIC_MOD dependent code */
 833         struct target_core_fabric_ops *se_tpg_tfo;
 834         struct se_wwn           *se_tpg_wwn;
 835         struct config_group     tpg_group;
 836         struct config_group     *tpg_default_groups[6];
 837         struct config_group     tpg_lun_group;
 838         struct config_group     tpg_np_group;
 839         struct config_group     tpg_acl_group;
 840         struct config_group     tpg_attrib_group;
 841         struct config_group     tpg_param_group;
 842 };
 843
 844 struct se_wwn {
 845         struct target_fabric_configfs *wwn_tf;
 846         struct config_group     wwn_group;
 847         struct config_group     *wwn_default_groups[2];
 848         struct config_group     fabric_stat_group;
 849 };
 850
 851 #endif /* TARGET_CORE_BASE_H */