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