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