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