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