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