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-rc1-ml"
  13
  14 /* Maximum Number of LUNs per Target Portal Group */
  15 /* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
  16 #define TRANSPORT_MAX_LUNS_PER_TPG              256
  17 /*
  18  * By default we use 32-byte CDBs in TCM Core and subsystem plugin code.
  19  *
  20  * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and
  21  * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use
  22  * 16-byte CDBs by default and require an extra allocation for
  23  * 32-byte CDBs to because of legacy issues.
  24  *
  25  * Within TCM Core there are no such legacy limitiations, so we go ahead
  26  * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size()
  27  * within all TCM Core and subsystem plugin code.
  28  */
  29 #define TCM_MAX_COMMAND_SIZE                    32
  30 /*
  31  * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
  32  * defined 96, but the real limit is 252 (or 260 including the header)
  33  */
  34 #define TRANSPORT_SENSE_BUFFER                  SCSI_SENSE_BUFFERSIZE
  35 /* Used by transport_send_check_condition_and_sense() */
  36 #define SPC_SENSE_KEY_OFFSET                    2
  37 #define SPC_ASC_KEY_OFFSET                      12
  38 #define SPC_ASCQ_KEY_OFFSET                     13
  39 #define TRANSPORT_IQN_LEN                       224
  40 /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
  41 #define LU_GROUP_NAME_BUF                       256
  42 /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
  43 #define TG_PT_GROUP_NAME_BUF                    256
  44 /* Used to parse VPD into struct t10_vpd */
  45 #define VPD_TMP_BUF_SIZE                        128
  46 /* Used by transport_generic_cmd_sequencer() */
  47 #define READ_BLOCK_LEN                          6
  48 #define READ_CAP_LEN                            8
  49 #define READ_POSITION_LEN                       20
  50 #define INQUIRY_LEN                             36
  51 /* Used by transport_get_inquiry_vpd_serial() */
  52 #define INQUIRY_VPD_SERIAL_LEN                  254
  53 /* Used by transport_get_inquiry_vpd_device_ident() */
  54 #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN       254
  55
  56 /* struct se_hba->hba_flags */
  57 enum hba_flags_table {
  58         HBA_FLAGS_INTERNAL_USE  = 0x01,
  59         HBA_FLAGS_PSCSI_MODE    = 0x02,
  60 };
  61
  62 /* struct se_lun->lun_status */
  63 enum transport_lun_status_table {
  64         TRANSPORT_LUN_STATUS_FREE = 0,
  65         TRANSPORT_LUN_STATUS_ACTIVE = 1,
  66 };
  67
  68 /* struct se_portal_group->se_tpg_type */
  69 enum transport_tpg_type_table {
  70         TRANSPORT_TPG_TYPE_NORMAL = 0,
  71         TRANSPORT_TPG_TYPE_DISCOVERY = 1,
  72 };
  73
  74 /* Used for generate timer flags */
  75 enum timer_flags_table {
  76         TF_RUNNING      = 0x01,
  77         TF_STOP         = 0x02,
  78 };
  79
  80 /* Special transport agnostic struct se_cmd->t_states */
  81 enum transport_state_table {
  82         TRANSPORT_NO_STATE      = 0,
  83         TRANSPORT_NEW_CMD       = 1,
  84         TRANSPORT_DEFERRED_CMD  = 2,
  85         TRANSPORT_WRITE_PENDING = 3,
  86         TRANSPORT_PROCESS_WRITE = 4,
  87         TRANSPORT_PROCESSING    = 5,
  88         TRANSPORT_COMPLETE_OK   = 6,
  89         TRANSPORT_COMPLETE_FAILURE = 7,
  90         TRANSPORT_COMPLETE_TIMEOUT = 8,
  91         TRANSPORT_PROCESS_TMR   = 9,
  92         TRANSPORT_TMR_COMPLETE  = 10,
  93         TRANSPORT_ISTATE_PROCESSING = 11,
  94         TRANSPORT_ISTATE_PROCESSED = 12,
  95         TRANSPORT_KILL          = 13,
  96         TRANSPORT_REMOVE        = 14,
  97         TRANSPORT_FREE          = 15,
  98         TRANSPORT_NEW_CMD_MAP   = 16,
  99         TRANSPORT_FREE_CMD_INTR = 17,
 100         TRANSPORT_COMPLETE_QF_WP = 18,
 101 };
 102
 103 /* Used for struct se_cmd->se_cmd_flags */
 104 enum se_cmd_flags_table {
 105         SCF_SUPPORTED_SAM_OPCODE        = 0x00000001,
 106         SCF_TRANSPORT_TASK_SENSE        = 0x00000002,
 107         SCF_EMULATED_TASK_SENSE         = 0x00000004,
 108         SCF_SCSI_DATA_SG_IO_CDB         = 0x00000008,
 109         SCF_SCSI_CONTROL_SG_IO_CDB      = 0x00000010,
 110         SCF_SCSI_NON_DATA_CDB           = 0x00000040,
 111         SCF_SCSI_CDB_EXCEPTION          = 0x00000080,
 112         SCF_SCSI_RESERVATION_CONFLICT   = 0x00000100,
 113         SCF_SE_CMD_FAILED               = 0x00000400,
 114         SCF_SE_LUN_CMD                  = 0x00000800,
 115         SCF_SE_ALLOW_EOO                = 0x00001000,
 116         SCF_SENT_CHECK_CONDITION        = 0x00004000,
 117         SCF_OVERFLOW_BIT                = 0x00008000,
 118         SCF_UNDERFLOW_BIT               = 0x00010000,
 119         SCF_SENT_DELAYED_TAS            = 0x00020000,
 120         SCF_ALUA_NON_OPTIMIZED          = 0x00040000,
 121         SCF_DELAYED_CMD_FROM_SAM_ATTR   = 0x00080000,
 122         SCF_UNUSED                      = 0x00100000,
 123         SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00400000,
 124         SCF_EMULATE_CDB_ASYNC           = 0x01000000,
 125         SCF_EMULATE_QUEUE_FULL          = 0x02000000,
 126 };
 127
 128 /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
 129 enum transport_lunflags_table {
 130         TRANSPORT_LUNFLAGS_NO_ACCESS            = 0x00,
 131         TRANSPORT_LUNFLAGS_INITIATOR_ACCESS     = 0x01,
 132         TRANSPORT_LUNFLAGS_READ_ONLY            = 0x02,
 133         TRANSPORT_LUNFLAGS_READ_WRITE           = 0x04,
 134 };
 135
 136 /* struct se_device->dev_status */
 137 enum transport_device_status_table {
 138         TRANSPORT_DEVICE_ACTIVATED              = 0x01,
 139         TRANSPORT_DEVICE_DEACTIVATED            = 0x02,
 140         TRANSPORT_DEVICE_QUEUE_FULL             = 0x04,
 141         TRANSPORT_DEVICE_SHUTDOWN               = 0x08,
 142         TRANSPORT_DEVICE_OFFLINE_ACTIVATED      = 0x10,
 143         TRANSPORT_DEVICE_OFFLINE_DEACTIVATED    = 0x20,
 144 };
 145
 146 /*
 147  * Used by transport_send_check_condition_and_sense() and se_cmd->scsi_sense_reason
 148  * to signal which ASC/ASCQ sense payload should be built.
 149  */
 150 enum tcm_sense_reason_table {
 151         TCM_NON_EXISTENT_LUN                    = 0x01,
 152         TCM_UNSUPPORTED_SCSI_OPCODE             = 0x02,
 153         TCM_INCORRECT_AMOUNT_OF_DATA            = 0x03,
 154         TCM_UNEXPECTED_UNSOLICITED_DATA         = 0x04,
 155         TCM_SERVICE_CRC_ERROR                   = 0x05,
 156         TCM_SNACK_REJECTED                      = 0x06,
 157         TCM_SECTOR_COUNT_TOO_MANY               = 0x07,
 158         TCM_INVALID_CDB_FIELD                   = 0x08,
 159         TCM_INVALID_PARAMETER_LIST              = 0x09,
 160         TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE  = 0x0a,
 161         TCM_UNKNOWN_MODE_PAGE                   = 0x0b,
 162         TCM_WRITE_PROTECTED                     = 0x0c,
 163         TCM_CHECK_CONDITION_ABORT_CMD           = 0x0d,
 164         TCM_CHECK_CONDITION_UNIT_ATTENTION      = 0x0e,
 165         TCM_CHECK_CONDITION_NOT_READY           = 0x0f,
 166 };
 167
 168 struct se_obj {
 169         atomic_t obj_access_count;
 170 } ____cacheline_aligned;
 171
 172 /*
 173  * Used by TCM Core internally to signal if ALUA emulation is enabled or
 174  * disabled, or running in with TCM/pSCSI passthrough mode
 175  */
 176 typedef enum {
 177         SPC_ALUA_PASSTHROUGH,
 178         SPC2_ALUA_DISABLED,
 179         SPC3_ALUA_EMULATED
 180 } t10_alua_index_t;
 181
 182 /*
 183  * Used by TCM Core internally to signal if SAM Task Attribute emulation
 184  * is enabled or disabled, or running in with TCM/pSCSI passthrough mode
 185  */
 186 typedef enum {
 187         SAM_TASK_ATTR_PASSTHROUGH,
 188         SAM_TASK_ATTR_UNTAGGED,
 189         SAM_TASK_ATTR_EMULATED
 190 } t10_task_attr_index_t;
 191
 192 /*
 193  * Used for target SCSI statistics
 194  */
 195 typedef enum {
 196         SCSI_INST_INDEX,
 197         SCSI_DEVICE_INDEX,
 198         SCSI_AUTH_INTR_INDEX,
 199         SCSI_INDEX_TYPE_MAX
 200 } scsi_index_t;
 201
 202 struct se_cmd;
 203
 204 struct t10_alua {
 205         t10_alua_index_t alua_type;
 206         /* ALUA Target Port Group ID */
 207         u16     alua_tg_pt_gps_counter;
 208         u32     alua_tg_pt_gps_count;
 209         spinlock_t tg_pt_gps_lock;
 210         struct se_subsystem_dev *t10_sub_dev;
 211         /* Used for default ALUA Target Port Group */
 212         struct t10_alua_tg_pt_gp *default_tg_pt_gp;
 213         /* Used for default ALUA Target Port Group ConfigFS group */
 214         struct config_group alua_tg_pt_gps_group;
 215         int (*alua_state_check)(struct se_cmd *, unsigned char *, u8 *);
 216         struct list_head tg_pt_gps_list;
 217 } ____cacheline_aligned;
 218
 219 struct t10_alua_lu_gp {
 220         u16     lu_gp_id;
 221         int     lu_gp_valid_id;
 222         u32     lu_gp_members;
 223         atomic_t lu_gp_shutdown;
 224         atomic_t lu_gp_ref_cnt;
 225         spinlock_t lu_gp_lock;
 226         struct config_group lu_gp_group;
 227         struct list_head lu_gp_node;
 228         struct list_head lu_gp_mem_list;
 229 } ____cacheline_aligned;
 230
 231 struct t10_alua_lu_gp_member {
 232         bool lu_gp_assoc;
 233         atomic_t lu_gp_mem_ref_cnt;
 234         spinlock_t lu_gp_mem_lock;
 235         struct t10_alua_lu_gp *lu_gp;
 236         struct se_device *lu_gp_mem_dev;
 237         struct list_head lu_gp_mem_list;
 238 } ____cacheline_aligned;
 239
 240 struct t10_alua_tg_pt_gp {
 241         u16     tg_pt_gp_id;
 242         int     tg_pt_gp_valid_id;
 243         int     tg_pt_gp_alua_access_status;
 244         int     tg_pt_gp_alua_access_type;
 245         int     tg_pt_gp_nonop_delay_msecs;
 246         int     tg_pt_gp_trans_delay_msecs;
 247         int     tg_pt_gp_pref;
 248         int     tg_pt_gp_write_metadata;
 249         /* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */
 250 #define ALUA_MD_BUF_LEN                         1024
 251         u32     tg_pt_gp_md_buf_len;
 252         u32     tg_pt_gp_members;
 253         atomic_t tg_pt_gp_alua_access_state;
 254         atomic_t tg_pt_gp_ref_cnt;
 255         spinlock_t tg_pt_gp_lock;
 256         struct mutex tg_pt_gp_md_mutex;
 257         struct se_subsystem_dev *tg_pt_gp_su_dev;
 258         struct config_group tg_pt_gp_group;
 259         struct list_head tg_pt_gp_list;
 260         struct list_head tg_pt_gp_mem_list;
 261 } ____cacheline_aligned;
 262
 263 struct t10_alua_tg_pt_gp_member {
 264         bool tg_pt_gp_assoc;
 265         atomic_t tg_pt_gp_mem_ref_cnt;
 266         spinlock_t tg_pt_gp_mem_lock;
 267         struct t10_alua_tg_pt_gp *tg_pt_gp;
 268         struct se_port *tg_pt;
 269         struct list_head tg_pt_gp_mem_list;
 270 } ____cacheline_aligned;
 271
 272 struct t10_vpd {
 273         unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
 274         int protocol_identifier_set;
 275         u32 protocol_identifier;
 276         u32 device_identifier_code_set;
 277         u32 association;
 278         u32 device_identifier_type;
 279         struct list_head vpd_list;
 280 } ____cacheline_aligned;
 281
 282 struct t10_wwn {
 283         char vendor[8];
 284         char model[16];
 285         char revision[4];
 286         char unit_serial[INQUIRY_VPD_SERIAL_LEN];
 287         spinlock_t t10_vpd_lock;
 288         struct se_subsystem_dev *t10_sub_dev;
 289         struct config_group t10_wwn_group;
 290         struct list_head t10_vpd_list;
 291 } ____cacheline_aligned;
 292
 293
 294 /*
 295  * Used by TCM Core internally to signal if >= SPC-3 persistent reservations
 296  * emulation is enabled or disabled, or running in with TCM/pSCSI passthrough
 297  * mode
 298  */
 299 typedef enum {
 300         SPC_PASSTHROUGH,
 301         SPC2_RESERVATIONS,
 302         SPC3_PERSISTENT_RESERVATIONS
 303 } t10_reservations_index_t;
 304
 305 struct t10_pr_registration {
 306         /* Used for fabrics that contain WWN+ISID */
 307 #define PR_REG_ISID_LEN                         16
 308         /* PR_REG_ISID_LEN + ',i,0x' */
 309 #define PR_REG_ISID_ID_LEN                      (PR_REG_ISID_LEN + 5)
 310         char pr_reg_isid[PR_REG_ISID_LEN];
 311         /* Used during APTPL metadata reading */
 312 #define PR_APTPL_MAX_IPORT_LEN                  256
 313         unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
 314         /* Used during APTPL metadata reading */
 315 #define PR_APTPL_MAX_TPORT_LEN                  256
 316         unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
 317         /* For writing out live meta data */
 318         unsigned char *pr_aptpl_buf;
 319         u16 pr_aptpl_rpti;
 320         u16 pr_reg_tpgt;
 321         /* Reservation effects all target ports */
 322         int pr_reg_all_tg_pt;
 323         /* Activate Persistence across Target Power Loss */
 324         int pr_reg_aptpl;
 325         int pr_res_holder;
 326         int pr_res_type;
 327         int pr_res_scope;
 328         /* Used for fabric initiator WWPNs using a ISID */
 329         bool isid_present_at_reg;
 330         u32 pr_res_mapped_lun;
 331         u32 pr_aptpl_target_lun;
 332         u32 pr_res_generation;
 333         u64 pr_reg_bin_isid;
 334         u64 pr_res_key;
 335         atomic_t pr_res_holders;
 336         struct se_node_acl *pr_reg_nacl;
 337         struct se_dev_entry *pr_reg_deve;
 338         struct se_lun *pr_reg_tg_pt_lun;
 339         struct list_head pr_reg_list;
 340         struct list_head pr_reg_abort_list;
 341         struct list_head pr_reg_aptpl_list;
 342         struct list_head pr_reg_atp_list;
 343         struct list_head pr_reg_atp_mem_list;
 344 } ____cacheline_aligned;
 345
 346 /*
 347  * This set of function pointer ops is set based upon SPC3_PERSISTENT_RESERVATIONS,
 348  * SPC2_RESERVATIONS or SPC_PASSTHROUGH in drivers/target/target_core_pr.c:
 349  * core_setup_reservations()
 350  */
 351 struct t10_reservation_ops {
 352         int (*t10_reservation_check)(struct se_cmd *, u32 *);
 353         int (*t10_seq_non_holder)(struct se_cmd *, unsigned char *, u32);
 354         int (*t10_pr_register)(struct se_cmd *);
 355         int (*t10_pr_clear)(struct se_cmd *);
 356 };
 357
 358 struct t10_reservation {
 359         /* Reservation effects all target ports */
 360         int pr_all_tg_pt;
 361         /* Activate Persistence across Target Power Loss enabled
 362          * for SCSI device */
 363         int pr_aptpl_active;
 364         /* Used by struct t10_reservation->pr_aptpl_buf_len */
 365 #define PR_APTPL_BUF_LEN                        8192
 366         u32 pr_aptpl_buf_len;
 367         u32 pr_generation;
 368         t10_reservations_index_t res_type;
 369         spinlock_t registration_lock;
 370         spinlock_t aptpl_reg_lock;
 371         /*
 372          * This will always be set by one individual I_T Nexus.
 373          * However with all_tg_pt=1, other I_T Nexus from the
 374          * same initiator can access PR reg/res info on a different
 375          * target port.
 376          *
 377          * There is also the 'All Registrants' case, where there is
 378          * a single *pr_res_holder of the reservation, but all
 379          * registrations are considered reservation holders.
 380          */
 381         struct se_node_acl *pr_res_holder;
 382         struct list_head registration_list;
 383         struct list_head aptpl_reg_list;
 384         struct t10_reservation_ops pr_ops;
 385 } ____cacheline_aligned;
 386
 387 struct se_queue_req {
 388         int                     state;
 389         struct se_cmd           *cmd;
 390         struct list_head        qr_list;
 391 } ____cacheline_aligned;
 392
 393 struct se_queue_obj {
 394         atomic_t                queue_cnt;
 395         spinlock_t              cmd_queue_lock;
 396         struct list_head        qobj_list;
 397         wait_queue_head_t       thread_wq;
 398 } ____cacheline_aligned;
 399
 400 struct se_task {
 401         unsigned char   task_sense;
 402         struct scatterlist *task_sg;
 403         u32             task_sg_nents;
 404         struct scatterlist *task_sg_bidi;
 405         u8              task_scsi_status;
 406         u8              task_flags;
 407         int             task_error_status;
 408         int             task_state_flags;
 409         bool            task_padded_sg;
 410         unsigned long long      task_lba;
 411         u32             task_no;
 412         u32             task_sectors;
 413         u32             task_size;
 414         enum dma_data_direction task_data_direction;
 415         struct se_cmd *task_se_cmd;
 416         struct se_device        *se_dev;
 417         struct completion       task_stop_comp;
 418         atomic_t        task_active;
 419         atomic_t        task_execute_queue;
 420         atomic_t        task_timeout;
 421         atomic_t        task_sent;
 422         atomic_t        task_stop;
 423         atomic_t        task_state_active;
 424         struct timer_list       task_timer;
 425         struct se_device *se_obj_ptr;
 426         struct list_head t_list;
 427         struct list_head t_execute_list;
 428         struct list_head t_state_list;
 429 } ____cacheline_aligned;
 430
 431 struct se_cmd {
 432         /* SAM response code being sent to initiator */
 433         u8                      scsi_status;
 434         u8                      scsi_asc;
 435         u8                      scsi_ascq;
 436         u8                      scsi_sense_reason;
 437         u16                     scsi_sense_length;
 438         /* Delay for ALUA Active/NonOptimized state access in milliseconds */
 439         int                     alua_nonop_delay;
 440         /* See include/linux/dma-mapping.h */
 441         enum dma_data_direction data_direction;
 442         /* For SAM Task Attribute */
 443         int                     sam_task_attr;
 444         /* Transport protocol dependent state, see transport_state_table */
 445         enum transport_state_table t_state;
 446         /* Transport protocol dependent state for out of order CmdSNs */
 447         int                     deferred_t_state;
 448         /* Transport specific error status */
 449         int                     transport_error_status;
 450         /* See se_cmd_flags_table */
 451         u32                     se_cmd_flags;
 452         u32                     se_ordered_id;
 453         /* Total size in bytes associated with command */
 454         u32                     data_length;
 455         /* SCSI Presented Data Transfer Length */
 456         u32                     cmd_spdtl;
 457         u32                     residual_count;
 458         u32                     orig_fe_lun;
 459         /* Persistent Reservation key */
 460         u64                     pr_res_key;
 461         atomic_t                transport_sent;
 462         /* Used for sense data */
 463         void                    *sense_buffer;
 464         struct list_head        se_delayed_node;
 465         struct list_head        se_ordered_node;
 466         struct list_head        se_lun_node;
 467         struct list_head        se_qf_node;
 468         struct se_device      *se_dev;
 469         struct se_dev_entry   *se_deve;
 470         struct se_device        *se_obj_ptr;
 471         struct se_device        *se_orig_obj_ptr;
 472         struct se_lun           *se_lun;
 473         /* Only used for internal passthrough and legacy TCM fabric modules */
 474         struct se_session       *se_sess;
 475         struct se_tmr_req       *se_tmr_req;
 476         struct list_head        se_queue_node;
 477         struct target_core_fabric_ops *se_tfo;
 478         int (*transport_emulate_cdb)(struct se_cmd *);
 479         void (*transport_split_cdb)(unsigned long long, u32, unsigned char *);
 480         void (*transport_complete_callback)(struct se_cmd *);
 481         int (*transport_qf_callback)(struct se_cmd *);
 482
 483         unsigned char           *t_task_cdb;
 484         unsigned char           __t_task_cdb[TCM_MAX_COMMAND_SIZE];
 485         unsigned long long      t_task_lba;
 486         int                     t_tasks_failed;
 487         int                     t_tasks_fua;
 488         bool                    t_tasks_bidi;
 489         u32                     t_tasks_sg_chained_no;
 490         atomic_t                t_fe_count;
 491         atomic_t                t_se_count;
 492         atomic_t                t_task_cdbs_left;
 493         atomic_t                t_task_cdbs_ex_left;
 494         atomic_t                t_task_cdbs_timeout_left;
 495         atomic_t                t_task_cdbs_sent;
 496         atomic_t                t_transport_aborted;
 497         atomic_t                t_transport_active;
 498         atomic_t                t_transport_complete;
 499         atomic_t                t_transport_queue_active;
 500         atomic_t                t_transport_sent;
 501         atomic_t                t_transport_stop;
 502         atomic_t                t_transport_timeout;
 503         atomic_t                transport_dev_active;
 504         atomic_t                transport_lun_active;
 505         atomic_t                transport_lun_fe_stop;
 506         atomic_t                transport_lun_stop;
 507         spinlock_t              t_state_lock;
 508         struct completion       t_transport_stop_comp;
 509         struct completion       transport_lun_fe_stop_comp;
 510         struct completion       transport_lun_stop_comp;
 511         struct scatterlist      *t_tasks_sg_chained;
 512
 513         /*
 514          * Used for pre-registered fabric SGL passthrough WRITE and READ
 515          * with the special SCF_PASSTHROUGH_CONTIG_TO_SG case for TCM_Loop
 516          * and other HW target mode fabric modules.
 517          */
 518         struct scatterlist      *t_task_pt_sgl;
 519         u32                     t_task_pt_sgl_num;
 520
 521         struct scatterlist      *t_data_sg;
 522         unsigned int            t_data_nents;
 523         struct scatterlist      *t_bidi_data_sg;
 524         unsigned int            t_bidi_data_nents;
 525
 526         /* Used for BIDI READ */
 527         struct list_head        t_task_list;
 528         u32                     t_task_list_num;
 529
 530 } ____cacheline_aligned;
 531
 532 struct se_tmr_req {
 533         /* Task Management function to be preformed */
 534         u8                      function;
 535         /* Task Management response to send */
 536         u8                      response;
 537         int                     call_transport;
 538         /* Reference to ITT that Task Mgmt should be preformed */
 539         u32                     ref_task_tag;
 540         /* 64-bit encoded SAM LUN from $FABRIC_MOD TMR header */
 541         u64                     ref_task_lun;
 542         void                    *fabric_tmr_ptr;
 543         struct se_cmd           *task_cmd;
 544         struct se_cmd           *ref_cmd;
 545         struct se_device        *tmr_dev;
 546         struct se_lun           *tmr_lun;
 547         struct list_head        tmr_list;
 548 } ____cacheline_aligned;
 549
 550 struct se_ua {
 551         u8                      ua_asc;
 552         u8                      ua_ascq;
 553         struct se_node_acl      *ua_nacl;
 554         struct list_head        ua_dev_list;
 555         struct list_head        ua_nacl_list;
 556 } ____cacheline_aligned;
 557
 558 struct se_node_acl {
 559         char                    initiatorname[TRANSPORT_IQN_LEN];
 560         /* Used to signal demo mode created ACL, disabled by default */
 561         bool                    dynamic_node_acl;
 562         u32                     queue_depth;
 563         u32                     acl_index;
 564         u64                     num_cmds;
 565         u64                     read_bytes;
 566         u64                     write_bytes;
 567         spinlock_t              stats_lock;
 568         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 569         atomic_t                acl_pr_ref_count;
 570         struct se_dev_entry     *device_list;
 571         struct se_session       *nacl_sess;
 572         struct se_portal_group *se_tpg;
 573         spinlock_t              device_list_lock;
 574         spinlock_t              nacl_sess_lock;
 575         struct config_group     acl_group;
 576         struct config_group     acl_attrib_group;
 577         struct config_group     acl_auth_group;
 578         struct config_group     acl_param_group;
 579         struct config_group     acl_fabric_stat_group;
 580         struct config_group     *acl_default_groups[5];
 581         struct list_head        acl_list;
 582         struct list_head        acl_sess_list;
 583 } ____cacheline_aligned;
 584
 585 struct se_session {
 586         u64                     sess_bin_isid;
 587         struct se_node_acl      *se_node_acl;
 588         struct se_portal_group *se_tpg;
 589         void                    *fabric_sess_ptr;
 590         struct list_head        sess_list;
 591         struct list_head        sess_acl_list;
 592 } ____cacheline_aligned;
 593
 594 struct se_device;
 595 struct se_transform_info;
 596 struct scatterlist;
 597
 598 struct se_ml_stat_grps {
 599         struct config_group     stat_group;
 600         struct config_group     scsi_auth_intr_group;
 601         struct config_group     scsi_att_intr_port_group;
 602 };
 603
 604 struct se_lun_acl {
 605         char                    initiatorname[TRANSPORT_IQN_LEN];
 606         u32                     mapped_lun;
 607         struct se_node_acl      *se_lun_nacl;
 608         struct se_lun           *se_lun;
 609         struct list_head        lacl_list;
 610         struct config_group     se_lun_group;
 611         struct se_ml_stat_grps  ml_stat_grps;
 612 }  ____cacheline_aligned;
 613
 614 struct se_dev_entry {
 615         bool                    def_pr_registered;
 616         /* See transport_lunflags_table */
 617         u32                     lun_flags;
 618         u32                     deve_cmds;
 619         u32                     mapped_lun;
 620         u32                     average_bytes;
 621         u32                     last_byte_count;
 622         u32                     total_cmds;
 623         u32                     total_bytes;
 624         u64                     pr_res_key;
 625         u64                     creation_time;
 626         u32                     attach_count;
 627         u64                     read_bytes;
 628         u64                     write_bytes;
 629         atomic_t                ua_count;
 630         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 631         atomic_t                pr_ref_count;
 632         struct se_lun_acl       *se_lun_acl;
 633         spinlock_t              ua_lock;
 634         struct se_lun           *se_lun;
 635         struct list_head        alua_port_list;
 636         struct list_head        ua_list;
 637 }  ____cacheline_aligned;
 638
 639 struct se_dev_limits {
 640         /* Max supported HW queue depth */
 641         u32             hw_queue_depth;
 642         /* Max supported virtual queue depth */
 643         u32             queue_depth;
 644         /* From include/linux/blkdev.h for the other HW/SW limits. */
 645         struct queue_limits limits;
 646 } ____cacheline_aligned;
 647
 648 struct se_dev_attrib {
 649         int             emulate_dpo;
 650         int             emulate_fua_write;
 651         int             emulate_fua_read;
 652         int             emulate_write_cache;
 653         int             emulate_ua_intlck_ctrl;
 654         int             emulate_tas;
 655         int             emulate_tpu;
 656         int             emulate_tpws;
 657         int             emulate_reservations;
 658         int             emulate_alua;
 659         int             enforce_pr_isids;
 660         int             is_nonrot;
 661         int             emulate_rest_reord;
 662         u32             hw_block_size;
 663         u32             block_size;
 664         u32             hw_max_sectors;
 665         u32             max_sectors;
 666         u32             optimal_sectors;
 667         u32             hw_queue_depth;
 668         u32             queue_depth;
 669         u32             task_timeout;
 670         u32             max_unmap_lba_count;
 671         u32             max_unmap_block_desc_count;
 672         u32             unmap_granularity;
 673         u32             unmap_granularity_alignment;
 674         struct se_subsystem_dev *da_sub_dev;
 675         struct config_group da_group;
 676 } ____cacheline_aligned;
 677
 678 struct se_dev_stat_grps {
 679         struct config_group stat_group;
 680         struct config_group scsi_dev_group;
 681         struct config_group scsi_tgt_dev_group;
 682         struct config_group scsi_lu_group;
 683 };
 684
 685 struct se_subsystem_dev {
 686 /* Used for struct se_subsystem_dev-->se_dev_alias, must be less than PAGE_SIZE */
 687 #define SE_DEV_ALIAS_LEN                512
 688         unsigned char   se_dev_alias[SE_DEV_ALIAS_LEN];
 689 /* Used for struct se_subsystem_dev->se_dev_udev_path[], must be less than PAGE_SIZE */
 690 #define SE_UDEV_PATH_LEN                512
 691         unsigned char   se_dev_udev_path[SE_UDEV_PATH_LEN];
 692         u32             su_dev_flags;
 693         struct se_hba *se_dev_hba;
 694         struct se_device *se_dev_ptr;
 695         struct se_dev_attrib se_dev_attrib;
 696         /* T10 Asymmetric Logical Unit Assignment for Target Ports */
 697         struct t10_alua t10_alua;
 698         /* T10 Inquiry and VPD WWN Information */
 699         struct t10_wwn  t10_wwn;
 700         /* T10 SPC-2 + SPC-3 Reservations */
 701         struct t10_reservation t10_pr;
 702         spinlock_t      se_dev_lock;
 703         void            *se_dev_su_ptr;
 704         struct list_head se_dev_node;
 705         struct config_group se_dev_group;
 706         /* For T10 Reservations */
 707         struct config_group se_dev_pr_group;
 708         /* For target_core_stat.c groups */
 709         struct se_dev_stat_grps dev_stat_grps;
 710 } ____cacheline_aligned;
 711
 712 struct se_device {
 713         /* Set to 1 if thread is NOT sleeping on thread_sem */
 714         u8                      thread_active;
 715         u8                      dev_status_timer_flags;
 716         /* RELATIVE TARGET PORT IDENTIFER Counter */
 717         u16                     dev_rpti_counter;
 718         /* Used for SAM Task Attribute ordering */
 719         u32                     dev_cur_ordered_id;
 720         u32                     dev_flags;
 721         u32                     dev_port_count;
 722         /* See transport_device_status_table */
 723         u32                     dev_status;
 724         u32                     dev_tcq_window_closed;
 725         /* Physical device queue depth */
 726         u32                     queue_depth;
 727         /* Used for SPC-2 reservations enforce of ISIDs */
 728         u64                     dev_res_bin_isid;
 729         t10_task_attr_index_t   dev_task_attr_type;
 730         /* Pointer to transport specific device structure */
 731         void                    *dev_ptr;
 732         u32                     dev_index;
 733         u64                     creation_time;
 734         u32                     num_resets;
 735         u64                     num_cmds;
 736         u64                     read_bytes;
 737         u64                     write_bytes;
 738         spinlock_t              stats_lock;
 739         /* Active commands on this virtual SE device */
 740         atomic_t                active_cmds;
 741         atomic_t                simple_cmds;
 742         atomic_t                depth_left;
 743         atomic_t                dev_ordered_id;
 744         atomic_t                dev_tur_active;
 745         atomic_t                execute_tasks;
 746         atomic_t                dev_status_thr_count;
 747         atomic_t                dev_hoq_count;
 748         atomic_t                dev_ordered_sync;
 749         atomic_t                dev_qf_count;
 750         struct se_obj           dev_obj;
 751         struct se_obj           dev_access_obj;
 752         struct se_obj           dev_export_obj;
 753         struct se_queue_obj     dev_queue_obj;
 754         spinlock_t              delayed_cmd_lock;
 755         spinlock_t              ordered_cmd_lock;
 756         spinlock_t              execute_task_lock;
 757         spinlock_t              state_task_lock;
 758         spinlock_t              dev_alua_lock;
 759         spinlock_t              dev_reservation_lock;
 760         spinlock_t              dev_state_lock;
 761         spinlock_t              dev_status_lock;
 762         spinlock_t              dev_status_thr_lock;
 763         spinlock_t              se_port_lock;
 764         spinlock_t              se_tmr_lock;
 765         spinlock_t              qf_cmd_lock;
 766         /* Used for legacy SPC-2 reservationsa */
 767         struct se_node_acl      *dev_reserved_node_acl;
 768         /* Used for ALUA Logical Unit Group membership */
 769         struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
 770         /* Used for SPC-3 Persistent Reservations */
 771         struct t10_pr_registration *dev_pr_res_holder;
 772         struct list_head        dev_sep_list;
 773         struct list_head        dev_tmr_list;
 774         struct timer_list       dev_status_timer;
 775         /* Pointer to descriptor for processing thread */
 776         struct task_struct      *process_thread;
 777         pid_t                   process_thread_pid;
 778         struct task_struct              *dev_mgmt_thread;
 779         struct work_struct      qf_work_queue;
 780         struct list_head        delayed_cmd_list;
 781         struct list_head        ordered_cmd_list;
 782         struct list_head        execute_task_list;
 783         struct list_head        state_task_list;
 784         struct list_head        qf_cmd_list;
 785         /* Pointer to associated SE HBA */
 786         struct se_hba           *se_hba;
 787         struct se_subsystem_dev *se_sub_dev;
 788         /* Pointer to template of function pointers for transport */
 789         struct se_subsystem_api *transport;
 790         /* Linked list for struct se_hba struct se_device list */
 791         struct list_head        dev_list;
 792         /* Linked list for struct se_global->g_se_dev_list */
 793         struct list_head        g_se_dev_list;
 794 }  ____cacheline_aligned;
 795
 796 struct se_hba {
 797         u16                     hba_tpgt;
 798         u32                     hba_id;
 799         /* See hba_flags_table */
 800         u32                     hba_flags;
 801         /* Virtual iSCSI devices attached. */
 802         u32                     dev_count;
 803         u32                     hba_index;
 804         /* Pointer to transport specific host structure. */
 805         void                    *hba_ptr;
 806         /* Linked list for struct se_device */
 807         struct list_head        hba_dev_list;
 808         struct list_head        hba_node;
 809         spinlock_t              device_lock;
 810         struct config_group     hba_group;
 811         struct mutex            hba_access_mutex;
 812         struct se_subsystem_api *transport;
 813 }  ____cacheline_aligned;
 814
 815 struct se_port_stat_grps {
 816         struct config_group stat_group;
 817         struct config_group scsi_port_group;
 818         struct config_group scsi_tgt_port_group;
 819         struct config_group scsi_transport_group;
 820 };
 821
 822 struct se_lun {
 823         /* See transport_lun_status_table */
 824         enum transport_lun_status_table lun_status;
 825         u32                     lun_access;
 826         u32                     lun_flags;
 827         u32                     unpacked_lun;
 828         atomic_t                lun_acl_count;
 829         spinlock_t              lun_acl_lock;
 830         spinlock_t              lun_cmd_lock;
 831         spinlock_t              lun_sep_lock;
 832         struct completion       lun_shutdown_comp;
 833         struct list_head        lun_cmd_list;
 834         struct list_head        lun_acl_list;
 835         struct se_device        *lun_se_dev;
 836         struct se_port          *lun_sep;
 837         struct config_group     lun_group;
 838         struct se_port_stat_grps port_stat_grps;
 839 } ____cacheline_aligned;
 840
 841 struct scsi_port_stats {
 842        u64     cmd_pdus;
 843        u64     tx_data_octets;
 844        u64     rx_data_octets;
 845 } ____cacheline_aligned;
 846
 847 struct se_port {
 848         /* RELATIVE TARGET PORT IDENTIFER */
 849         u16             sep_rtpi;
 850         int             sep_tg_pt_secondary_stat;
 851         int             sep_tg_pt_secondary_write_md;
 852         u32             sep_index;
 853         struct scsi_port_stats sep_stats;
 854         /* Used for ALUA Target Port Groups membership */
 855         atomic_t        sep_tg_pt_gp_active;
 856         atomic_t        sep_tg_pt_secondary_offline;
 857         /* Used for PR ALL_TG_PT=1 */
 858         atomic_t        sep_tg_pt_ref_cnt;
 859         spinlock_t      sep_alua_lock;
 860         struct mutex    sep_tg_pt_md_mutex;
 861         struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
 862         struct se_lun *sep_lun;
 863         struct se_portal_group *sep_tpg;
 864         struct list_head sep_alua_list;
 865         struct list_head sep_list;
 866 } ____cacheline_aligned;
 867
 868 struct se_tpg_np {
 869         struct se_portal_group *tpg_np_parent;
 870         struct config_group     tpg_np_group;
 871 } ____cacheline_aligned;
 872
 873 struct se_portal_group {
 874         /* Type of target portal group, see transport_tpg_type_table */
 875         enum transport_tpg_type_table se_tpg_type;
 876         /* Number of ACLed Initiator Nodes for this TPG */
 877         u32                     num_node_acls;
 878         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 879         atomic_t                tpg_pr_ref_count;
 880         /* Spinlock for adding/removing ACLed Nodes */
 881         spinlock_t              acl_node_lock;
 882         /* Spinlock for adding/removing sessions */
 883         spinlock_t              session_lock;
 884         spinlock_t              tpg_lun_lock;
 885         /* Pointer to $FABRIC_MOD portal group */
 886         void                    *se_tpg_fabric_ptr;
 887         struct list_head        se_tpg_node;
 888         /* linked list for initiator ACL list */
 889         struct list_head        acl_node_list;
 890         struct se_lun           *tpg_lun_list;
 891         struct se_lun           tpg_virt_lun0;
 892         /* List of TCM sessions associated wth this TPG */
 893         struct list_head        tpg_sess_list;
 894         /* Pointer to $FABRIC_MOD dependent code */
 895         struct target_core_fabric_ops *se_tpg_tfo;
 896         struct se_wwn           *se_tpg_wwn;
 897         struct config_group     tpg_group;
 898         struct config_group     *tpg_default_groups[6];
 899         struct config_group     tpg_lun_group;
 900         struct config_group     tpg_np_group;
 901         struct config_group     tpg_acl_group;
 902         struct config_group     tpg_attrib_group;
 903         struct config_group     tpg_param_group;
 904 } ____cacheline_aligned;
 905
 906 struct se_wwn {
 907         struct target_fabric_configfs *wwn_tf;
 908         struct config_group     wwn_group;
 909         struct config_group     *wwn_default_groups[2];
 910         struct config_group     fabric_stat_group;
 911 } ____cacheline_aligned;
 912
 913 #endif /* TARGET_CORE_BASE_H */