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