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