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 <linux/percpu_ida.h>
   9 #include <scsi/scsi_cmnd.h>
  10 #include <net/sock.h>
  11 #include <net/tcp.h>
  12
  13 #define TARGET_CORE_MOD_VERSION         "v4.1.0"
  14 #define TARGET_CORE_VERSION             TARGET_CORE_MOD_VERSION
  15
  16 /* Maximum Number of LUNs per Target Portal Group */
  17 /* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */
  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_DESC_TYPE_OFFSET                    8
  41 #define SPC_ADDITIONAL_DESC_LEN_OFFSET          9
  42 #define SPC_VALIDITY_OFFSET                     10
  43 #define SPC_ASC_KEY_OFFSET                      12
  44 #define SPC_ASCQ_KEY_OFFSET                     13
  45 #define TRANSPORT_IQN_LEN                       224
  46 /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
  47 #define LU_GROUP_NAME_BUF                       256
  48 /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
  49 #define TG_PT_GROUP_NAME_BUF                    256
  50 /* Used to parse VPD into struct t10_vpd */
  51 #define VPD_TMP_BUF_SIZE                        254
  52 /* Used by transport_generic_cmd_sequencer() */
  53 #define READ_BLOCK_LEN                          6
  54 #define READ_CAP_LEN                            8
  55 #define READ_POSITION_LEN                       20
  56 #define INQUIRY_LEN                             36
  57 /* Used by transport_get_inquiry_vpd_serial() */
  58 #define INQUIRY_VPD_SERIAL_LEN                  254
  59 /* Used by transport_get_inquiry_vpd_device_ident() */
  60 #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN       254
  61
  62 /* Attempts before moving from SHORT to LONG */
  63 #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD   3
  64 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT  3  /* In milliseconds */
  65 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG   10 /* In milliseconds */
  66
  67 #define PYX_TRANSPORT_STATUS_INTERVAL           5 /* In seconds */
  68
  69 /* struct se_dev_attrib sanity values */
  70 /* Default max_unmap_lba_count */
  71 #define DA_MAX_UNMAP_LBA_COUNT                  0
  72 /* Default max_unmap_block_desc_count */
  73 #define DA_MAX_UNMAP_BLOCK_DESC_COUNT           0
  74 /* Default unmap_granularity */
  75 #define DA_UNMAP_GRANULARITY_DEFAULT            0
  76 /* Default unmap_granularity_alignment */
  77 #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT  0
  78 /* Default max_write_same_len, disabled by default */
  79 #define DA_MAX_WRITE_SAME_LEN                   0
  80 /* Default max transfer length */
  81 #define DA_FABRIC_MAX_SECTORS                   8192
  82 /* Use a model alias based on the configfs backend device name */
  83 #define DA_EMULATE_MODEL_ALIAS                  0
  84 /* Emulation for Direct Page Out */
  85 #define DA_EMULATE_DPO                          0
  86 /* Emulation for Forced Unit Access WRITEs */
  87 #define DA_EMULATE_FUA_WRITE                    1
  88 /* Emulation for Forced Unit Access READs */
  89 #define DA_EMULATE_FUA_READ                     0
  90 /* Emulation for WriteCache and SYNCHRONIZE_CACHE */
  91 #define DA_EMULATE_WRITE_CACHE                  0
  92 /* Emulation for UNIT ATTENTION Interlock Control */
  93 #define DA_EMULATE_UA_INTLLCK_CTRL              0
  94 /* Emulation for TASK_ABORTED status (TAS) by default */
  95 #define DA_EMULATE_TAS                          1
  96 /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
  97 #define DA_EMULATE_TPU                          0
  98 /*
  99  * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
 100  * block/blk-lib.c:blkdev_issue_discard()
 101  */
 102 #define DA_EMULATE_TPWS                         0
 103 /* Emulation for CompareAndWrite (AtomicTestandSet) by default */
 104 #define DA_EMULATE_CAW                          1
 105 /* Emulation for 3rd Party Copy (ExtendedCopy) by default */
 106 #define DA_EMULATE_3PC                          1
 107 /* No Emulation for PSCSI by default */
 108 #define DA_EMULATE_ALUA                         0
 109 /* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
 110 #define DA_ENFORCE_PR_ISIDS                     1
 111 #define DA_STATUS_MAX_SECTORS_MIN               16
 112 #define DA_STATUS_MAX_SECTORS_MAX               8192
 113 /* By default don't report non-rotating (solid state) medium */
 114 #define DA_IS_NONROT                            0
 115 /* Queue Algorithm Modifier default for restricted reordering in control mode page */
 116 #define DA_EMULATE_REST_REORD                   0
 117
 118 #define SE_INQUIRY_BUF                          1024
 119 #define SE_MODE_PAGE_BUF                        512
 120 #define SE_SENSE_BUF                            96
 121
 122 /* struct se_hba->hba_flags */
 123 enum hba_flags_table {
 124         HBA_FLAGS_INTERNAL_USE  = 0x01,
 125         HBA_FLAGS_PSCSI_MODE    = 0x02,
 126 };
 127
 128 /* struct se_lun->lun_status */
 129 enum transport_lun_status_table {
 130         TRANSPORT_LUN_STATUS_FREE = 0,
 131         TRANSPORT_LUN_STATUS_ACTIVE = 1,
 132 };
 133
 134 /* struct se_portal_group->se_tpg_type */
 135 enum transport_tpg_type_table {
 136         TRANSPORT_TPG_TYPE_NORMAL = 0,
 137         TRANSPORT_TPG_TYPE_DISCOVERY = 1,
 138 };
 139
 140 /* Special transport agnostic struct se_cmd->t_states */
 141 enum transport_state_table {
 142         TRANSPORT_NO_STATE      = 0,
 143         TRANSPORT_NEW_CMD       = 1,
 144         TRANSPORT_WRITE_PENDING = 3,
 145         TRANSPORT_PROCESSING    = 5,
 146         TRANSPORT_COMPLETE      = 6,
 147         TRANSPORT_ISTATE_PROCESSING = 11,
 148         TRANSPORT_COMPLETE_QF_WP = 18,
 149         TRANSPORT_COMPLETE_QF_OK = 19,
 150 };
 151
 152 /* Used for struct se_cmd->se_cmd_flags */
 153 enum se_cmd_flags_table {
 154         SCF_SUPPORTED_SAM_OPCODE        = 0x00000001,
 155         SCF_TRANSPORT_TASK_SENSE        = 0x00000002,
 156         SCF_EMULATED_TASK_SENSE         = 0x00000004,
 157         SCF_SCSI_DATA_CDB               = 0x00000008,
 158         SCF_SCSI_TMR_CDB                = 0x00000010,
 159         SCF_FUA                         = 0x00000080,
 160         SCF_SE_LUN_CMD                  = 0x00000100,
 161         SCF_BIDI                        = 0x00000400,
 162         SCF_SENT_CHECK_CONDITION        = 0x00000800,
 163         SCF_OVERFLOW_BIT                = 0x00001000,
 164         SCF_UNDERFLOW_BIT               = 0x00002000,
 165         SCF_SEND_DELAYED_TAS            = 0x00004000,
 166         SCF_ALUA_NON_OPTIMIZED          = 0x00008000,
 167         SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00020000,
 168         SCF_ACK_KREF                    = 0x00040000,
 169         SCF_COMPARE_AND_WRITE           = 0x00080000,
 170         SCF_COMPARE_AND_WRITE_POST      = 0x00100000,
 171         SCF_CMD_XCOPY_PASSTHROUGH       = 0x00200000,
 172 };
 173
 174 /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */
 175 enum transport_lunflags_table {
 176         TRANSPORT_LUNFLAGS_NO_ACCESS            = 0x00,
 177         TRANSPORT_LUNFLAGS_INITIATOR_ACCESS     = 0x01,
 178         TRANSPORT_LUNFLAGS_READ_ONLY            = 0x02,
 179         TRANSPORT_LUNFLAGS_READ_WRITE           = 0x04,
 180 };
 181
 182 /*
 183  * Used by transport_send_check_condition_and_sense()
 184  * to signal which ASC/ASCQ sense payload should be built.
 185  */
 186 typedef unsigned __bitwise__ sense_reason_t;
 187
 188 enum tcm_sense_reason_table {
 189 #define R(x)    (__force sense_reason_t )(x)
 190         TCM_NO_SENSE                            = R(0x00),
 191         TCM_NON_EXISTENT_LUN                    = R(0x01),
 192         TCM_UNSUPPORTED_SCSI_OPCODE             = R(0x02),
 193         TCM_INCORRECT_AMOUNT_OF_DATA            = R(0x03),
 194         TCM_UNEXPECTED_UNSOLICITED_DATA         = R(0x04),
 195         TCM_SERVICE_CRC_ERROR                   = R(0x05),
 196         TCM_SNACK_REJECTED                      = R(0x06),
 197         TCM_SECTOR_COUNT_TOO_MANY               = R(0x07),
 198         TCM_INVALID_CDB_FIELD                   = R(0x08),
 199         TCM_INVALID_PARAMETER_LIST              = R(0x09),
 200         TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE  = R(0x0a),
 201         TCM_UNKNOWN_MODE_PAGE                   = R(0x0b),
 202         TCM_WRITE_PROTECTED                     = R(0x0c),
 203         TCM_CHECK_CONDITION_ABORT_CMD           = R(0x0d),
 204         TCM_CHECK_CONDITION_UNIT_ATTENTION      = R(0x0e),
 205         TCM_CHECK_CONDITION_NOT_READY           = R(0x0f),
 206         TCM_RESERVATION_CONFLICT                = R(0x10),
 207         TCM_ADDRESS_OUT_OF_RANGE                = R(0x11),
 208         TCM_OUT_OF_RESOURCES                    = R(0x12),
 209         TCM_PARAMETER_LIST_LENGTH_ERROR         = R(0x13),
 210         TCM_MISCOMPARE_VERIFY                   = R(0x14),
 211         TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED    = R(0x15),
 212         TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED  = R(0x16),
 213         TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED  = R(0x17),
 214 #undef R
 215 };
 216
 217 enum target_sc_flags_table {
 218         TARGET_SCF_BIDI_OP              = 0x01,
 219         TARGET_SCF_ACK_KREF             = 0x02,
 220         TARGET_SCF_UNKNOWN_SIZE         = 0x04,
 221 };
 222
 223 /* fabric independent task management function values */
 224 enum tcm_tmreq_table {
 225         TMR_ABORT_TASK          = 1,
 226         TMR_ABORT_TASK_SET      = 2,
 227         TMR_CLEAR_ACA           = 3,
 228         TMR_CLEAR_TASK_SET      = 4,
 229         TMR_LUN_RESET           = 5,
 230         TMR_TARGET_WARM_RESET   = 6,
 231         TMR_TARGET_COLD_RESET   = 7,
 232 };
 233
 234 /* fabric independent task management response values */
 235 enum tcm_tmrsp_table {
 236         TMR_FUNCTION_FAILED             = 0,
 237         TMR_FUNCTION_COMPLETE           = 1,
 238         TMR_TASK_DOES_NOT_EXIST         = 2,
 239         TMR_LUN_DOES_NOT_EXIST          = 3,
 240         TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED    = 4,
 241         TMR_FUNCTION_REJECTED           = 5,
 242 };
 243
 244 /*
 245  * Used for target SCSI statistics
 246  */
 247 typedef enum {
 248         SCSI_INST_INDEX,
 249         SCSI_DEVICE_INDEX,
 250         SCSI_AUTH_INTR_INDEX,
 251         SCSI_INDEX_TYPE_MAX
 252 } scsi_index_t;
 253
 254 struct se_cmd;
 255
 256 struct t10_alua_lba_map_member {
 257         struct list_head lba_map_mem_list;
 258         int lba_map_mem_alua_state;
 259         int lba_map_mem_alua_pg_id;
 260 };
 261
 262 struct t10_alua_lba_map {
 263         u64 lba_map_first_lba;
 264         u64 lba_map_last_lba;
 265         struct list_head lba_map_list;
 266         struct list_head lba_map_mem_list;
 267 };
 268
 269 struct t10_alua {
 270         /* ALUA Target Port Group ID */
 271         u16     alua_tg_pt_gps_counter;
 272         u32     alua_tg_pt_gps_count;
 273         /* Referrals support */
 274         spinlock_t lba_map_lock;
 275         u32     lba_map_segment_size;
 276         u32     lba_map_segment_multiplier;
 277         struct list_head lba_map_list;
 278         spinlock_t tg_pt_gps_lock;
 279         struct se_device *t10_dev;
 280         /* Used for default ALUA Target Port Group */
 281         struct t10_alua_tg_pt_gp *default_tg_pt_gp;
 282         /* Used for default ALUA Target Port Group ConfigFS group */
 283         struct config_group alua_tg_pt_gps_group;
 284         struct list_head tg_pt_gps_list;
 285 };
 286
 287 struct t10_alua_lu_gp {
 288         u16     lu_gp_id;
 289         int     lu_gp_valid_id;
 290         u32     lu_gp_members;
 291         atomic_t lu_gp_ref_cnt;
 292         spinlock_t lu_gp_lock;
 293         struct config_group lu_gp_group;
 294         struct list_head lu_gp_node;
 295         struct list_head lu_gp_mem_list;
 296 };
 297
 298 struct t10_alua_lu_gp_member {
 299         bool lu_gp_assoc;
 300         atomic_t lu_gp_mem_ref_cnt;
 301         spinlock_t lu_gp_mem_lock;
 302         struct t10_alua_lu_gp *lu_gp;
 303         struct se_device *lu_gp_mem_dev;
 304         struct list_head lu_gp_mem_list;
 305 };
 306
 307 struct t10_alua_tg_pt_gp {
 308         u16     tg_pt_gp_id;
 309         int     tg_pt_gp_valid_id;
 310         int     tg_pt_gp_alua_supported_states;
 311         int     tg_pt_gp_alua_pending_state;
 312         int     tg_pt_gp_alua_previous_state;
 313         int     tg_pt_gp_alua_access_status;
 314         int     tg_pt_gp_alua_access_type;
 315         int     tg_pt_gp_nonop_delay_msecs;
 316         int     tg_pt_gp_trans_delay_msecs;
 317         int     tg_pt_gp_implicit_trans_secs;
 318         int     tg_pt_gp_pref;
 319         int     tg_pt_gp_write_metadata;
 320         u32     tg_pt_gp_members;
 321         atomic_t tg_pt_gp_alua_access_state;
 322         atomic_t tg_pt_gp_ref_cnt;
 323         spinlock_t tg_pt_gp_lock;
 324         struct mutex tg_pt_gp_md_mutex;
 325         struct se_device *tg_pt_gp_dev;
 326         struct config_group tg_pt_gp_group;
 327         struct list_head tg_pt_gp_list;
 328         struct list_head tg_pt_gp_mem_list;
 329         struct se_port *tg_pt_gp_alua_port;
 330         struct se_node_acl *tg_pt_gp_alua_nacl;
 331         struct delayed_work tg_pt_gp_transition_work;
 332         struct completion *tg_pt_gp_transition_complete;
 333 };
 334
 335 struct t10_alua_tg_pt_gp_member {
 336         bool tg_pt_gp_assoc;
 337         atomic_t tg_pt_gp_mem_ref_cnt;
 338         spinlock_t tg_pt_gp_mem_lock;
 339         struct t10_alua_tg_pt_gp *tg_pt_gp;
 340         struct se_port *tg_pt;
 341         struct list_head tg_pt_gp_mem_list;
 342 };
 343
 344 struct t10_vpd {
 345         unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
 346         int protocol_identifier_set;
 347         u32 protocol_identifier;
 348         u32 device_identifier_code_set;
 349         u32 association;
 350         u32 device_identifier_type;
 351         struct list_head vpd_list;
 352 };
 353
 354 struct t10_wwn {
 355         char vendor[8];
 356         char model[16];
 357         char revision[4];
 358         char unit_serial[INQUIRY_VPD_SERIAL_LEN];
 359         spinlock_t t10_vpd_lock;
 360         struct se_device *t10_dev;
 361         struct config_group t10_wwn_group;
 362         struct list_head t10_vpd_list;
 363 };
 364
 365 struct t10_pr_registration {
 366         /* Used for fabrics that contain WWN+ISID */
 367 #define PR_REG_ISID_LEN                         16
 368         /* PR_REG_ISID_LEN + ',i,0x' */
 369 #define PR_REG_ISID_ID_LEN                      (PR_REG_ISID_LEN + 5)
 370         char pr_reg_isid[PR_REG_ISID_LEN];
 371         /* Used during APTPL metadata reading */
 372 #define PR_APTPL_MAX_IPORT_LEN                  256
 373         unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
 374         /* Used during APTPL metadata reading */
 375 #define PR_APTPL_MAX_TPORT_LEN                  256
 376         unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
 377         u16 pr_aptpl_rpti;
 378         u16 pr_reg_tpgt;
 379         /* Reservation effects all target ports */
 380         int pr_reg_all_tg_pt;
 381         /* Activate Persistence across Target Power Loss */
 382         int pr_reg_aptpl;
 383         int pr_res_holder;
 384         int pr_res_type;
 385         int pr_res_scope;
 386         /* Used for fabric initiator WWPNs using a ISID */
 387         bool isid_present_at_reg;
 388         u32 pr_res_mapped_lun;
 389         u32 pr_aptpl_target_lun;
 390         u32 pr_res_generation;
 391         u64 pr_reg_bin_isid;
 392         u64 pr_res_key;
 393         atomic_t pr_res_holders;
 394         struct se_node_acl *pr_reg_nacl;
 395         struct se_dev_entry *pr_reg_deve;
 396         struct se_lun *pr_reg_tg_pt_lun;
 397         struct list_head pr_reg_list;
 398         struct list_head pr_reg_abort_list;
 399         struct list_head pr_reg_aptpl_list;
 400         struct list_head pr_reg_atp_list;
 401         struct list_head pr_reg_atp_mem_list;
 402 };
 403
 404 struct t10_reservation {
 405         /* Reservation effects all target ports */
 406         int pr_all_tg_pt;
 407         /* Activate Persistence across Target Power Loss enabled
 408          * for SCSI device */
 409         int pr_aptpl_active;
 410 #define PR_APTPL_BUF_LEN                        8192
 411         u32 pr_generation;
 412         spinlock_t registration_lock;
 413         spinlock_t aptpl_reg_lock;
 414         /*
 415          * This will always be set by one individual I_T Nexus.
 416          * However with all_tg_pt=1, other I_T Nexus from the
 417          * same initiator can access PR reg/res info on a different
 418          * target port.
 419          *
 420          * There is also the 'All Registrants' case, where there is
 421          * a single *pr_res_holder of the reservation, but all
 422          * registrations are considered reservation holders.
 423          */
 424         struct se_node_acl *pr_res_holder;
 425         struct list_head registration_list;
 426         struct list_head aptpl_reg_list;
 427 };
 428
 429 struct se_tmr_req {
 430         /* Task Management function to be performed */
 431         u8                      function;
 432         /* Task Management response to send */
 433         u8                      response;
 434         int                     call_transport;
 435         /* Reference to ITT that Task Mgmt should be performed */
 436         u32                     ref_task_tag;
 437         void                    *fabric_tmr_ptr;
 438         struct se_cmd           *task_cmd;
 439         struct se_device        *tmr_dev;
 440         struct se_lun           *tmr_lun;
 441         struct list_head        tmr_list;
 442 };
 443
 444 enum target_prot_op {
 445         TARGET_PROT_NORMAL      = 0,
 446         TARGET_PROT_DIN_INSERT  = (1 << 0),
 447         TARGET_PROT_DOUT_INSERT = (1 << 1),
 448         TARGET_PROT_DIN_STRIP   = (1 << 2),
 449         TARGET_PROT_DOUT_STRIP  = (1 << 3),
 450         TARGET_PROT_DIN_PASS    = (1 << 4),
 451         TARGET_PROT_DOUT_PASS   = (1 << 5),
 452 };
 453
 454 #define TARGET_PROT_ALL TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \
 455                         TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \
 456                         TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS
 457
 458 enum target_prot_type {
 459         TARGET_DIF_TYPE0_PROT,
 460         TARGET_DIF_TYPE1_PROT,
 461         TARGET_DIF_TYPE2_PROT,
 462         TARGET_DIF_TYPE3_PROT,
 463 };
 464
 465 enum target_core_dif_check {
 466         TARGET_DIF_CHECK_GUARD  = 0x1 << 0,
 467         TARGET_DIF_CHECK_APPTAG = 0x1 << 1,
 468         TARGET_DIF_CHECK_REFTAG = 0x1 << 2,
 469 };
 470
 471 struct se_dif_v1_tuple {
 472         __be16                  guard_tag;
 473         __be16                  app_tag;
 474         __be32                  ref_tag;
 475 };
 476
 477 struct se_cmd {
 478         /* SAM response code being sent to initiator */
 479         u8                      scsi_status;
 480         u8                      scsi_asc;
 481         u8                      scsi_ascq;
 482         u16                     scsi_sense_length;
 483         /* Delay for ALUA Active/NonOptimized state access in milliseconds */
 484         int                     alua_nonop_delay;
 485         /* See include/linux/dma-mapping.h */
 486         enum dma_data_direction data_direction;
 487         /* For SAM Task Attribute */
 488         int                     sam_task_attr;
 489         /* Used for se_sess->sess_tag_pool */
 490         unsigned int            map_tag;
 491         /* Transport protocol dependent state, see transport_state_table */
 492         enum transport_state_table t_state;
 493         unsigned                cmd_wait_set:1;
 494         unsigned                unknown_data_length:1;
 495         /* See se_cmd_flags_table */
 496         u32                     se_cmd_flags;
 497         u32                     se_ordered_id;
 498         /* Total size in bytes associated with command */
 499         u32                     data_length;
 500         u32                     residual_count;
 501         u32                     orig_fe_lun;
 502         /* Persistent Reservation key */
 503         u64                     pr_res_key;
 504         /* Used for sense data */
 505         void                    *sense_buffer;
 506         struct list_head        se_delayed_node;
 507         struct list_head        se_qf_node;
 508         struct se_device      *se_dev;
 509         struct se_dev_entry   *se_deve;
 510         struct se_lun           *se_lun;
 511         /* Only used for internal passthrough and legacy TCM fabric modules */
 512         struct se_session       *se_sess;
 513         struct se_tmr_req       *se_tmr_req;
 514         struct list_head        se_cmd_list;
 515         struct completion       cmd_wait_comp;
 516         struct kref             cmd_kref;
 517         struct target_core_fabric_ops *se_tfo;
 518         sense_reason_t          (*execute_cmd)(struct se_cmd *);
 519         sense_reason_t          (*execute_rw)(struct se_cmd *, struct scatterlist *,
 520                                               u32, enum dma_data_direction);
 521         sense_reason_t (*transport_complete_callback)(struct se_cmd *);
 522
 523         unsigned char           *t_task_cdb;
 524         unsigned char           __t_task_cdb[TCM_MAX_COMMAND_SIZE];
 525         unsigned long long      t_task_lba;
 526         unsigned int            t_task_nolb;
 527         unsigned int            transport_state;
 528 #define CMD_T_ABORTED           (1 << 0)
 529 #define CMD_T_ACTIVE            (1 << 1)
 530 #define CMD_T_COMPLETE          (1 << 2)
 531 #define CMD_T_SENT              (1 << 4)
 532 #define CMD_T_STOP              (1 << 5)
 533 #define CMD_T_DEV_ACTIVE        (1 << 7)
 534 #define CMD_T_REQUEST_STOP      (1 << 8)
 535 #define CMD_T_BUSY              (1 << 9)
 536         spinlock_t              t_state_lock;
 537         struct completion       t_transport_stop_comp;
 538
 539         struct work_struct      work;
 540
 541         struct scatterlist      *t_data_sg;
 542         struct scatterlist      *t_data_sg_orig;
 543         unsigned int            t_data_nents;
 544         unsigned int            t_data_nents_orig;
 545         void                    *t_data_vmap;
 546         struct scatterlist      *t_bidi_data_sg;
 547         unsigned int            t_bidi_data_nents;
 548
 549         struct list_head        state_list;
 550         bool                    state_active;
 551
 552         /* old task stop completion, consider merging with some of the above */
 553         struct completion       task_stop_comp;
 554
 555         /* backend private data */
 556         void                    *priv;
 557
 558         /* Used for lun->lun_ref counting */
 559         int                     lun_ref_active;
 560
 561         /* DIF related members */
 562         enum target_prot_op     prot_op;
 563         enum target_prot_type   prot_type;
 564         u8                      prot_checks;
 565         u32                     prot_length;
 566         u32                     reftag_seed;
 567         struct scatterlist      *t_prot_sg;
 568         unsigned int            t_prot_nents;
 569         sense_reason_t          pi_err;
 570         sector_t                bad_sector;
 571         bool                    prot_pto;
 572 };
 573
 574 struct se_ua {
 575         u8                      ua_asc;
 576         u8                      ua_ascq;
 577         struct se_node_acl      *ua_nacl;
 578         struct list_head        ua_nacl_list;
 579 };
 580
 581 struct se_node_acl {
 582         char                    initiatorname[TRANSPORT_IQN_LEN];
 583         /* Used to signal demo mode created ACL, disabled by default */
 584         bool                    dynamic_node_acl;
 585         bool                    acl_stop:1;
 586         u32                     queue_depth;
 587         u32                     acl_index;
 588 #define MAX_ACL_TAG_SIZE 64
 589         char                    acl_tag[MAX_ACL_TAG_SIZE];
 590         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 591         atomic_t                acl_pr_ref_count;
 592         struct se_dev_entry     **device_list;
 593         struct se_session       *nacl_sess;
 594         struct se_portal_group *se_tpg;
 595         spinlock_t              device_list_lock;
 596         spinlock_t              nacl_sess_lock;
 597         struct config_group     acl_group;
 598         struct config_group     acl_attrib_group;
 599         struct config_group     acl_auth_group;
 600         struct config_group     acl_param_group;
 601         struct config_group     acl_fabric_stat_group;
 602         struct config_group     *acl_default_groups[5];
 603         struct list_head        acl_list;
 604         struct list_head        acl_sess_list;
 605         struct completion       acl_free_comp;
 606         struct kref             acl_kref;
 607 };
 608
 609 struct se_session {
 610         unsigned                sess_tearing_down:1;
 611         u64                     sess_bin_isid;
 612         enum target_prot_op     sup_prot_ops;
 613         struct se_node_acl      *se_node_acl;
 614         struct se_portal_group *se_tpg;
 615         void                    *fabric_sess_ptr;
 616         struct list_head        sess_list;
 617         struct list_head        sess_acl_list;
 618         struct list_head        sess_cmd_list;
 619         struct list_head        sess_wait_list;
 620         spinlock_t              sess_cmd_lock;
 621         struct kref             sess_kref;
 622         void                    *sess_cmd_map;
 623         struct percpu_ida       sess_tag_pool;
 624 };
 625
 626 struct se_device;
 627 struct se_transform_info;
 628 struct scatterlist;
 629
 630 struct se_ml_stat_grps {
 631         struct config_group     stat_group;
 632         struct config_group     scsi_auth_intr_group;
 633         struct config_group     scsi_att_intr_port_group;
 634 };
 635
 636 struct se_lun_acl {
 637         char                    initiatorname[TRANSPORT_IQN_LEN];
 638         u32                     mapped_lun;
 639         struct se_node_acl      *se_lun_nacl;
 640         struct se_lun           *se_lun;
 641         struct list_head        lacl_list;
 642         struct config_group     se_lun_group;
 643         struct se_ml_stat_grps  ml_stat_grps;
 644 };
 645
 646 struct se_dev_entry {
 647         bool                    def_pr_registered;
 648         /* See transport_lunflags_table */
 649         u32                     lun_flags;
 650         u32                     mapped_lun;
 651         u32                     total_cmds;
 652         u64                     pr_res_key;
 653         u64                     creation_time;
 654         u32                     attach_count;
 655         u64                     read_bytes;
 656         u64                     write_bytes;
 657         atomic_t                ua_count;
 658         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 659         atomic_t                pr_ref_count;
 660         struct se_lun_acl       *se_lun_acl;
 661         spinlock_t              ua_lock;
 662         struct se_lun           *se_lun;
 663         struct list_head        alua_port_list;
 664         struct list_head        ua_list;
 665 };
 666
 667 struct se_dev_attrib {
 668         int             emulate_model_alias;
 669         int             emulate_dpo;
 670         int             emulate_fua_write;
 671         int             emulate_fua_read;
 672         int             emulate_write_cache;
 673         int             emulate_ua_intlck_ctrl;
 674         int             emulate_tas;
 675         int             emulate_tpu;
 676         int             emulate_tpws;
 677         int             emulate_caw;
 678         int             emulate_3pc;
 679         int             pi_prot_format;
 680         enum target_prot_type pi_prot_type;
 681         enum target_prot_type hw_pi_prot_type;
 682         int             enforce_pr_isids;
 683         int             is_nonrot;
 684         int             emulate_rest_reord;
 685         u32             hw_block_size;
 686         u32             block_size;
 687         u32             hw_max_sectors;
 688         u32             fabric_max_sectors;
 689         u32             optimal_sectors;
 690         u32             hw_queue_depth;
 691         u32             queue_depth;
 692         u32             max_unmap_lba_count;
 693         u32             max_unmap_block_desc_count;
 694         u32             unmap_granularity;
 695         u32             unmap_granularity_alignment;
 696         u32             max_write_same_len;
 697         u32             max_bytes_per_io;
 698         struct se_device *da_dev;
 699         struct config_group da_group;
 700 };
 701
 702 struct se_port_stat_grps {
 703         struct config_group stat_group;
 704         struct config_group scsi_port_group;
 705         struct config_group scsi_tgt_port_group;
 706         struct config_group scsi_transport_group;
 707 };
 708
 709 struct se_lun {
 710 #define SE_LUN_LINK_MAGIC                       0xffff7771
 711         u32                     lun_link_magic;
 712         /* See transport_lun_status_table */
 713         enum transport_lun_status_table lun_status;
 714         u32                     lun_access;
 715         u32                     lun_flags;
 716         u32                     unpacked_lun;
 717         atomic_t                lun_acl_count;
 718         spinlock_t              lun_acl_lock;
 719         spinlock_t              lun_sep_lock;
 720         struct completion       lun_shutdown_comp;
 721         struct list_head        lun_acl_list;
 722         struct se_device        *lun_se_dev;
 723         struct se_port          *lun_sep;
 724         struct config_group     lun_group;
 725         struct se_port_stat_grps port_stat_grps;
 726         struct completion       lun_ref_comp;
 727         struct percpu_ref       lun_ref;
 728 };
 729
 730 struct se_dev_stat_grps {
 731         struct config_group stat_group;
 732         struct config_group scsi_dev_group;
 733         struct config_group scsi_tgt_dev_group;
 734         struct config_group scsi_lu_group;
 735 };
 736
 737 struct se_device {
 738 #define SE_DEV_LINK_MAGIC                       0xfeeddeef
 739         u32                     dev_link_magic;
 740         /* RELATIVE TARGET PORT IDENTIFER Counter */
 741         u16                     dev_rpti_counter;
 742         /* Used for SAM Task Attribute ordering */
 743         u32                     dev_cur_ordered_id;
 744         u32                     dev_flags;
 745 #define DF_CONFIGURED                           0x00000001
 746 #define DF_FIRMWARE_VPD_UNIT_SERIAL             0x00000002
 747 #define DF_EMULATED_VPD_UNIT_SERIAL             0x00000004
 748 #define DF_USING_UDEV_PATH                      0x00000008
 749 #define DF_USING_ALIAS                          0x00000010
 750         u32                     dev_port_count;
 751         /* Physical device queue depth */
 752         u32                     queue_depth;
 753         /* Used for SPC-2 reservations enforce of ISIDs */
 754         u64                     dev_res_bin_isid;
 755         /* Pointer to transport specific device structure */
 756         u32                     dev_index;
 757         u64                     creation_time;
 758         atomic_long_t           num_resets;
 759         atomic_long_t           num_cmds;
 760         atomic_long_t           read_bytes;
 761         atomic_long_t           write_bytes;
 762         /* Active commands on this virtual SE device */
 763         atomic_t                simple_cmds;
 764         atomic_t                dev_ordered_id;
 765         atomic_t                dev_ordered_sync;
 766         atomic_t                dev_qf_count;
 767         int                     export_count;
 768         spinlock_t              delayed_cmd_lock;
 769         spinlock_t              execute_task_lock;
 770         spinlock_t              dev_reservation_lock;
 771         unsigned int            dev_reservation_flags;
 772 #define DRF_SPC2_RESERVATIONS                   0x00000001
 773 #define DRF_SPC2_RESERVATIONS_WITH_ISID         0x00000002
 774         spinlock_t              se_port_lock;
 775         spinlock_t              se_tmr_lock;
 776         spinlock_t              qf_cmd_lock;
 777         struct semaphore        caw_sem;
 778         /* Used for legacy SPC-2 reservationsa */
 779         struct se_node_acl      *dev_reserved_node_acl;
 780         /* Used for ALUA Logical Unit Group membership */
 781         struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
 782         /* Used for SPC-3 Persistent Reservations */
 783         struct t10_pr_registration *dev_pr_res_holder;
 784         struct list_head        dev_sep_list;
 785         struct list_head        dev_tmr_list;
 786         struct workqueue_struct *tmr_wq;
 787         struct work_struct      qf_work_queue;
 788         struct list_head        delayed_cmd_list;
 789         struct list_head        state_list;
 790         struct list_head        qf_cmd_list;
 791         struct list_head        g_dev_node;
 792         /* Pointer to associated SE HBA */
 793         struct se_hba           *se_hba;
 794         /* T10 Inquiry and VPD WWN Information */
 795         struct t10_wwn          t10_wwn;
 796         /* T10 Asymmetric Logical Unit Assignment for Target Ports */
 797         struct t10_alua         t10_alua;
 798         /* T10 SPC-2 + SPC-3 Reservations */
 799         struct t10_reservation  t10_pr;
 800         struct se_dev_attrib    dev_attrib;
 801         struct config_group     dev_group;
 802         struct config_group     dev_pr_group;
 803         struct se_dev_stat_grps dev_stat_grps;
 804 #define SE_DEV_ALIAS_LEN 512            /* must be less than PAGE_SIZE */
 805         unsigned char           dev_alias[SE_DEV_ALIAS_LEN];
 806 #define SE_UDEV_PATH_LEN 512            /* must be less than PAGE_SIZE */
 807         unsigned char           udev_path[SE_UDEV_PATH_LEN];
 808         /* Pointer to template of function pointers for transport */
 809         struct se_subsystem_api *transport;
 810         /* Linked list for struct se_hba struct se_device list */
 811         struct list_head        dev_list;
 812         struct se_lun           xcopy_lun;
 813         /* Protection Information */
 814         int                     prot_length;
 815 };
 816
 817 struct se_hba {
 818         u16                     hba_tpgt;
 819         u32                     hba_id;
 820         /* See hba_flags_table */
 821         u32                     hba_flags;
 822         /* Virtual iSCSI devices attached. */
 823         u32                     dev_count;
 824         u32                     hba_index;
 825         /* Pointer to transport specific host structure. */
 826         void                    *hba_ptr;
 827         struct list_head        hba_node;
 828         spinlock_t              device_lock;
 829         struct config_group     hba_group;
 830         struct mutex            hba_access_mutex;
 831         struct se_subsystem_api *transport;
 832 };
 833
 834 struct scsi_port_stats {
 835        u64     cmd_pdus;
 836        u64     tx_data_octets;
 837        u64     rx_data_octets;
 838 };
 839
 840 struct se_port {
 841         /* RELATIVE TARGET PORT IDENTIFER */
 842         u16             sep_rtpi;
 843         int             sep_tg_pt_secondary_stat;
 844         int             sep_tg_pt_secondary_write_md;
 845         u32             sep_index;
 846         struct scsi_port_stats sep_stats;
 847         /* Used for ALUA Target Port Groups membership */
 848         atomic_t        sep_tg_pt_secondary_offline;
 849         /* Used for PR ALL_TG_PT=1 */
 850         atomic_t        sep_tg_pt_ref_cnt;
 851         spinlock_t      sep_alua_lock;
 852         struct mutex    sep_tg_pt_md_mutex;
 853         struct t10_alua_tg_pt_gp_member *sep_alua_tg_pt_gp_mem;
 854         struct se_lun *sep_lun;
 855         struct se_portal_group *sep_tpg;
 856         struct list_head sep_alua_list;
 857         struct list_head sep_list;
 858 };
 859
 860 struct se_tpg_np {
 861         struct se_portal_group *tpg_np_parent;
 862         struct config_group     tpg_np_group;
 863 };
 864
 865 struct se_portal_group {
 866         /* Type of target portal group, see transport_tpg_type_table */
 867         enum transport_tpg_type_table se_tpg_type;
 868         /* Number of ACLed Initiator Nodes for this TPG */
 869         u32                     num_node_acls;
 870         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 871         atomic_t                tpg_pr_ref_count;
 872         /* Spinlock for adding/removing ACLed Nodes */
 873         spinlock_t              acl_node_lock;
 874         /* Spinlock for adding/removing sessions */
 875         spinlock_t              session_lock;
 876         spinlock_t              tpg_lun_lock;
 877         /* Pointer to $FABRIC_MOD portal group */
 878         void                    *se_tpg_fabric_ptr;
 879         struct list_head        se_tpg_node;
 880         /* linked list for initiator ACL list */
 881         struct list_head        acl_node_list;
 882         struct se_lun           **tpg_lun_list;
 883         struct se_lun           tpg_virt_lun0;
 884         /* List of TCM sessions associated wth this TPG */
 885         struct list_head        tpg_sess_list;
 886         /* Pointer to $FABRIC_MOD dependent code */
 887         struct target_core_fabric_ops *se_tpg_tfo;
 888         struct se_wwn           *se_tpg_wwn;
 889         struct config_group     tpg_group;
 890         struct config_group     *tpg_default_groups[7];
 891         struct config_group     tpg_lun_group;
 892         struct config_group     tpg_np_group;
 893         struct config_group     tpg_acl_group;
 894         struct config_group     tpg_attrib_group;
 895         struct config_group     tpg_auth_group;
 896         struct config_group     tpg_param_group;
 897 };
 898
 899 struct se_wwn {
 900         struct target_fabric_configfs *wwn_tf;
 901         struct config_group     wwn_group;
 902         struct config_group     *wwn_default_groups[2];
 903         struct config_group     fabric_stat_group;
 904 };
 905
 906 #endif /* TARGET_CORE_BASE_H */