include/target/target_core_base.h

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