include/target/target_core_base.h

   1 #ifndef TARGET_CORE_BASE_H
   2 #define TARGET_CORE_BASE_H
   3
   4 #include <linux/configfs.h>      /* struct config_group */
   5 #include <linux/dma-direction.h> /* enum dma_data_direction */
   6 #include <linux/percpu_ida.h>    /* struct percpu_ida */
   7 #include <linux/percpu-refcount.h>
   8 #include <linux/semaphore.h>     /* struct semaphore */
   9 #include <linux/completion.h>
  10
  11 #define TARGET_CORE_VERSION             "v5.0"
  12
  13 /*
  14  * Maximum size of a CDB that can be stored in se_cmd without allocating
  15  * memory dynamically for the CDB.
  16  */
  17 #define TCM_MAX_COMMAND_SIZE                    32
  18 /*
  19  * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently
  20  * defined 96, but the real limit is 252 (or 260 including the header)
  21  */
  22 #define TRANSPORT_SENSE_BUFFER                  96
  23 /* Used by transport_send_check_condition_and_sense() */
  24 #define SPC_SENSE_KEY_OFFSET                    2
  25 #define SPC_ADD_SENSE_LEN_OFFSET                7
  26 #define SPC_DESC_TYPE_OFFSET                    8
  27 #define SPC_ADDITIONAL_DESC_LEN_OFFSET          9
  28 #define SPC_VALIDITY_OFFSET                     10
  29 #define SPC_ASC_KEY_OFFSET                      12
  30 #define SPC_ASCQ_KEY_OFFSET                     13
  31 #define TRANSPORT_IQN_LEN                       224
  32 /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */
  33 #define LU_GROUP_NAME_BUF                       256
  34 /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */
  35 #define TG_PT_GROUP_NAME_BUF                    256
  36 /* Used to parse VPD into struct t10_vpd */
  37 #define VPD_TMP_BUF_SIZE                        254
  38 /* Used by transport_generic_cmd_sequencer() */
  39 #define READ_BLOCK_LEN                          6
  40 #define READ_CAP_LEN                            8
  41 #define READ_POSITION_LEN                       20
  42 #define INQUIRY_LEN                             36
  43 /* Used by transport_get_inquiry_vpd_serial() */
  44 #define INQUIRY_VPD_SERIAL_LEN                  254
  45 /* Used by transport_get_inquiry_vpd_device_ident() */
  46 #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN       254
  47
  48 /* Attempts before moving from SHORT to LONG */
  49 #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD   3
  50 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT  3  /* In milliseconds */
  51 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG   10 /* In milliseconds */
  52
  53 #define PYX_TRANSPORT_STATUS_INTERVAL           5 /* In seconds */
  54
  55 /* struct se_dev_attrib sanity values */
  56 /* Default max_unmap_lba_count */
  57 #define DA_MAX_UNMAP_LBA_COUNT                  0
  58 /* Default max_unmap_block_desc_count */
  59 #define DA_MAX_UNMAP_BLOCK_DESC_COUNT           0
  60 /* Default unmap_granularity */
  61 #define DA_UNMAP_GRANULARITY_DEFAULT            0
  62 /* Default unmap_granularity_alignment */
  63 #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT  0
  64 /* Default unmap_zeroes_data */
  65 #define DA_UNMAP_ZEROES_DATA_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_USE_CPUID                   = 0x00800000,
 143         SCF_TASK_ATTR_SET               = 0x01000000,
 144 };
 145
 146 /*
 147  * Used by transport_send_check_condition_and_sense()
 148  * to signal which ASC/ASCQ sense payload should be built.
 149  */
 150 typedef unsigned __bitwise sense_reason_t;
 151
 152 enum tcm_sense_reason_table {
 153 #define R(x)    (__force sense_reason_t )(x)
 154         TCM_NO_SENSE                            = R(0x00),
 155         TCM_NON_EXISTENT_LUN                    = R(0x01),
 156         TCM_UNSUPPORTED_SCSI_OPCODE             = R(0x02),
 157         TCM_INCORRECT_AMOUNT_OF_DATA            = R(0x03),
 158         TCM_UNEXPECTED_UNSOLICITED_DATA         = R(0x04),
 159         TCM_SERVICE_CRC_ERROR                   = R(0x05),
 160         TCM_SNACK_REJECTED                      = R(0x06),
 161         TCM_SECTOR_COUNT_TOO_MANY               = R(0x07),
 162         TCM_INVALID_CDB_FIELD                   = R(0x08),
 163         TCM_INVALID_PARAMETER_LIST              = R(0x09),
 164         TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE  = R(0x0a),
 165         TCM_UNKNOWN_MODE_PAGE                   = R(0x0b),
 166         TCM_WRITE_PROTECTED                     = R(0x0c),
 167         TCM_CHECK_CONDITION_ABORT_CMD           = R(0x0d),
 168         TCM_CHECK_CONDITION_UNIT_ATTENTION      = R(0x0e),
 169         TCM_CHECK_CONDITION_NOT_READY           = R(0x0f),
 170         TCM_RESERVATION_CONFLICT                = R(0x10),
 171         TCM_ADDRESS_OUT_OF_RANGE                = R(0x11),
 172         TCM_OUT_OF_RESOURCES                    = R(0x12),
 173         TCM_PARAMETER_LIST_LENGTH_ERROR         = R(0x13),
 174         TCM_MISCOMPARE_VERIFY                   = R(0x14),
 175         TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED    = R(0x15),
 176         TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED  = R(0x16),
 177         TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED  = R(0x17),
 178         TCM_COPY_TARGET_DEVICE_NOT_REACHABLE    = R(0x18),
 179         TCM_TOO_MANY_TARGET_DESCS               = R(0x19),
 180         TCM_UNSUPPORTED_TARGET_DESC_TYPE_CODE   = R(0x1a),
 181         TCM_TOO_MANY_SEGMENT_DESCS              = R(0x1b),
 182         TCM_UNSUPPORTED_SEGMENT_DESC_TYPE_CODE  = R(0x1c),
 183 #undef R
 184 };
 185
 186 enum target_sc_flags_table {
 187         TARGET_SCF_BIDI_OP              = 0x01,
 188         TARGET_SCF_ACK_KREF             = 0x02,
 189         TARGET_SCF_UNKNOWN_SIZE         = 0x04,
 190         TARGET_SCF_USE_CPUID    = 0x08,
 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         TMR_UNKNOWN             = 0xff,
 203 };
 204
 205 /* fabric independent task management response values */
 206 enum tcm_tmrsp_table {
 207         TMR_FUNCTION_FAILED             = 0,
 208         TMR_FUNCTION_COMPLETE           = 1,
 209         TMR_TASK_DOES_NOT_EXIST         = 2,
 210         TMR_LUN_DOES_NOT_EXIST          = 3,
 211         TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED    = 4,
 212         TMR_FUNCTION_REJECTED           = 5,
 213 };
 214
 215 /*
 216  * Used for target SCSI statistics
 217  */
 218 typedef enum {
 219         SCSI_INST_INDEX,
 220         SCSI_DEVICE_INDEX,
 221         SCSI_AUTH_INTR_INDEX,
 222         SCSI_INDEX_TYPE_MAX
 223 } scsi_index_t;
 224
 225 struct se_cmd;
 226
 227 struct t10_alua_lba_map_member {
 228         struct list_head lba_map_mem_list;
 229         int lba_map_mem_alua_state;
 230         int lba_map_mem_alua_pg_id;
 231 };
 232
 233 struct t10_alua_lba_map {
 234         u64 lba_map_first_lba;
 235         u64 lba_map_last_lba;
 236         struct list_head lba_map_list;
 237         struct list_head lba_map_mem_list;
 238 };
 239
 240 struct t10_alua {
 241         /* ALUA Target Port Group ID */
 242         u16     alua_tg_pt_gps_counter;
 243         u32     alua_tg_pt_gps_count;
 244         /* Referrals support */
 245         spinlock_t lba_map_lock;
 246         u32     lba_map_segment_size;
 247         u32     lba_map_segment_multiplier;
 248         struct list_head lba_map_list;
 249         spinlock_t tg_pt_gps_lock;
 250         struct se_device *t10_dev;
 251         /* Used for default ALUA Target Port Group */
 252         struct t10_alua_tg_pt_gp *default_tg_pt_gp;
 253         /* Used for default ALUA Target Port Group ConfigFS group */
 254         struct config_group alua_tg_pt_gps_group;
 255         struct list_head tg_pt_gps_list;
 256 };
 257
 258 struct t10_alua_lu_gp {
 259         u16     lu_gp_id;
 260         int     lu_gp_valid_id;
 261         u32     lu_gp_members;
 262         atomic_t lu_gp_ref_cnt;
 263         spinlock_t lu_gp_lock;
 264         struct config_group lu_gp_group;
 265         struct list_head lu_gp_node;
 266         struct list_head lu_gp_mem_list;
 267 };
 268
 269 struct t10_alua_lu_gp_member {
 270         bool lu_gp_assoc;
 271         atomic_t lu_gp_mem_ref_cnt;
 272         spinlock_t lu_gp_mem_lock;
 273         struct t10_alua_lu_gp *lu_gp;
 274         struct se_device *lu_gp_mem_dev;
 275         struct list_head lu_gp_mem_list;
 276 };
 277
 278 struct t10_alua_tg_pt_gp {
 279         u16     tg_pt_gp_id;
 280         int     tg_pt_gp_valid_id;
 281         int     tg_pt_gp_alua_supported_states;
 282         int     tg_pt_gp_alua_pending_state;
 283         int     tg_pt_gp_alua_previous_state;
 284         int     tg_pt_gp_alua_access_status;
 285         int     tg_pt_gp_alua_access_type;
 286         int     tg_pt_gp_nonop_delay_msecs;
 287         int     tg_pt_gp_trans_delay_msecs;
 288         int     tg_pt_gp_implicit_trans_secs;
 289         int     tg_pt_gp_pref;
 290         int     tg_pt_gp_write_metadata;
 291         u32     tg_pt_gp_members;
 292         atomic_t tg_pt_gp_alua_access_state;
 293         atomic_t tg_pt_gp_ref_cnt;
 294         spinlock_t tg_pt_gp_lock;
 295         struct mutex tg_pt_gp_md_mutex;
 296         struct se_device *tg_pt_gp_dev;
 297         struct config_group tg_pt_gp_group;
 298         struct list_head tg_pt_gp_list;
 299         struct list_head tg_pt_gp_lun_list;
 300         struct se_lun *tg_pt_gp_alua_lun;
 301         struct se_node_acl *tg_pt_gp_alua_nacl;
 302         struct delayed_work tg_pt_gp_transition_work;
 303         struct completion *tg_pt_gp_transition_complete;
 304 };
 305
 306 struct t10_vpd {
 307         unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];
 308         int protocol_identifier_set;
 309         u32 protocol_identifier;
 310         u32 device_identifier_code_set;
 311         u32 association;
 312         u32 device_identifier_type;
 313         struct list_head vpd_list;
 314 };
 315
 316 struct t10_wwn {
 317         char vendor[8];
 318         char model[16];
 319         char revision[4];
 320         char unit_serial[INQUIRY_VPD_SERIAL_LEN];
 321         spinlock_t t10_vpd_lock;
 322         struct se_device *t10_dev;
 323         struct config_group t10_wwn_group;
 324         struct list_head t10_vpd_list;
 325 };
 326
 327 struct t10_pr_registration {
 328         /* Used for fabrics that contain WWN+ISID */
 329 #define PR_REG_ISID_LEN                         16
 330         /* PR_REG_ISID_LEN + ',i,0x' */
 331 #define PR_REG_ISID_ID_LEN                      (PR_REG_ISID_LEN + 5)
 332         char pr_reg_isid[PR_REG_ISID_LEN];
 333         /* Used during APTPL metadata reading */
 334 #define PR_APTPL_MAX_IPORT_LEN                  256
 335         unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];
 336         /* Used during APTPL metadata reading */
 337 #define PR_APTPL_MAX_TPORT_LEN                  256
 338         unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];
 339         u16 pr_aptpl_rpti;
 340         u16 pr_reg_tpgt;
 341         /* Reservation effects all target ports */
 342         int pr_reg_all_tg_pt;
 343         /* Activate Persistence across Target Power Loss */
 344         int pr_reg_aptpl;
 345         int pr_res_holder;
 346         int pr_res_type;
 347         int pr_res_scope;
 348         /* Used for fabric initiator WWPNs using a ISID */
 349         bool isid_present_at_reg;
 350         u64 pr_res_mapped_lun;
 351         u64 pr_aptpl_target_lun;
 352         u16 tg_pt_sep_rtpi;
 353         u32 pr_res_generation;
 354         u64 pr_reg_bin_isid;
 355         u64 pr_res_key;
 356         atomic_t pr_res_holders;
 357         struct se_node_acl *pr_reg_nacl;
 358         /* Used by ALL_TG_PT=1 registration with deve->pr_ref taken */
 359         struct se_dev_entry *pr_reg_deve;
 360         struct list_head pr_reg_list;
 361         struct list_head pr_reg_abort_list;
 362         struct list_head pr_reg_aptpl_list;
 363         struct list_head pr_reg_atp_list;
 364         struct list_head pr_reg_atp_mem_list;
 365 };
 366
 367 struct t10_reservation {
 368         /* Reservation effects all target ports */
 369         int pr_all_tg_pt;
 370         /* Activate Persistence across Target Power Loss enabled
 371          * for SCSI device */
 372         int pr_aptpl_active;
 373 #define PR_APTPL_BUF_LEN                        262144
 374         u32 pr_generation;
 375         spinlock_t registration_lock;
 376         spinlock_t aptpl_reg_lock;
 377         /*
 378          * This will always be set by one individual I_T Nexus.
 379          * However with all_tg_pt=1, other I_T Nexus from the
 380          * same initiator can access PR reg/res info on a different
 381          * target port.
 382          *
 383          * There is also the 'All Registrants' case, where there is
 384          * a single *pr_res_holder of the reservation, but all
 385          * registrations are considered reservation holders.
 386          */
 387         struct se_node_acl *pr_res_holder;
 388         struct list_head registration_list;
 389         struct list_head aptpl_reg_list;
 390 };
 391
 392 struct se_tmr_req {
 393         /* Task Management function to be performed */
 394         u8                      function;
 395         /* Task Management response to send */
 396         u8                      response;
 397         int                     call_transport;
 398         /* Reference to ITT that Task Mgmt should be performed */
 399         u64                     ref_task_tag;
 400         void                    *fabric_tmr_ptr;
 401         struct se_cmd           *task_cmd;
 402         struct se_device        *tmr_dev;
 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_TAS               (1 << 10)
 494 #define CMD_T_FABRIC_STOP       (1 << 11)
 495         spinlock_t              t_state_lock;
 496         struct kref             cmd_kref;
 497         struct completion       t_transport_stop_comp;
 498
 499         struct work_struct      work;
 500
 501         struct scatterlist      *t_data_sg;
 502         struct scatterlist      *t_data_sg_orig;
 503         unsigned int            t_data_nents;
 504         unsigned int            t_data_nents_orig;
 505         void                    *t_data_vmap;
 506         struct scatterlist      *t_bidi_data_sg;
 507         unsigned int            t_bidi_data_nents;
 508
 509         /* Used for lun->lun_ref counting */
 510         int                     lun_ref_active;
 511
 512         struct list_head        state_list;
 513
 514         /* backend private data */
 515         void                    *priv;
 516
 517         /* DIF related members */
 518         enum target_prot_op     prot_op;
 519         enum target_prot_type   prot_type;
 520         u8                      prot_checks;
 521         bool                    prot_pto;
 522         u32                     prot_length;
 523         u32                     reftag_seed;
 524         struct scatterlist      *t_prot_sg;
 525         unsigned int            t_prot_nents;
 526         sense_reason_t          pi_err;
 527         sector_t                bad_sector;
 528         int                     cpuid;
 529 };
 530
 531 struct se_ua {
 532         u8                      ua_asc;
 533         u8                      ua_ascq;
 534         struct list_head        ua_nacl_list;
 535 };
 536
 537 struct se_node_acl {
 538         char                    initiatorname[TRANSPORT_IQN_LEN];
 539         /* Used to signal demo mode created ACL, disabled by default */
 540         bool                    dynamic_node_acl;
 541         bool                    dynamic_stop;
 542         u32                     queue_depth;
 543         u32                     acl_index;
 544         enum target_prot_type   saved_prot_type;
 545 #define MAX_ACL_TAG_SIZE 64
 546         char                    acl_tag[MAX_ACL_TAG_SIZE];
 547         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 548         atomic_t                acl_pr_ref_count;
 549         struct hlist_head       lun_entry_hlist;
 550         struct se_session       *nacl_sess;
 551         struct se_portal_group *se_tpg;
 552         struct mutex            lun_entry_mutex;
 553         spinlock_t              nacl_sess_lock;
 554         struct config_group     acl_group;
 555         struct config_group     acl_attrib_group;
 556         struct config_group     acl_auth_group;
 557         struct config_group     acl_param_group;
 558         struct config_group     acl_fabric_stat_group;
 559         struct list_head        acl_list;
 560         struct list_head        acl_sess_list;
 561         struct completion       acl_free_comp;
 562         struct kref             acl_kref;
 563 };
 564
 565 static inline struct se_node_acl *acl_to_nacl(struct config_item *item)
 566 {
 567         return container_of(to_config_group(item), struct se_node_acl,
 568                         acl_group);
 569 }
 570
 571 static inline struct se_node_acl *attrib_to_nacl(struct config_item *item)
 572 {
 573         return container_of(to_config_group(item), struct se_node_acl,
 574                         acl_attrib_group);
 575 }
 576
 577 static inline struct se_node_acl *auth_to_nacl(struct config_item *item)
 578 {
 579         return container_of(to_config_group(item), struct se_node_acl,
 580                         acl_auth_group);
 581 }
 582
 583 static inline struct se_node_acl *param_to_nacl(struct config_item *item)
 584 {
 585         return container_of(to_config_group(item), struct se_node_acl,
 586                         acl_param_group);
 587 }
 588
 589 static inline struct se_node_acl *fabric_stat_to_nacl(struct config_item *item)
 590 {
 591         return container_of(to_config_group(item), struct se_node_acl,
 592                         acl_fabric_stat_group);
 593 }
 594
 595 struct se_session {
 596         unsigned                sess_tearing_down:1;
 597         u64                     sess_bin_isid;
 598         enum target_prot_op     sup_prot_ops;
 599         enum target_prot_type   sess_prot_type;
 600         struct se_node_acl      *se_node_acl;
 601         struct se_portal_group *se_tpg;
 602         void                    *fabric_sess_ptr;
 603         struct list_head        sess_list;
 604         struct list_head        sess_acl_list;
 605         struct list_head        sess_cmd_list;
 606         struct list_head        sess_wait_list;
 607         spinlock_t              sess_cmd_lock;
 608         void                    *sess_cmd_map;
 609         struct percpu_ida       sess_tag_pool;
 610 };
 611
 612 struct se_device;
 613 struct se_transform_info;
 614 struct scatterlist;
 615
 616 struct se_ml_stat_grps {
 617         struct config_group     stat_group;
 618         struct config_group     scsi_auth_intr_group;
 619         struct config_group     scsi_att_intr_port_group;
 620 };
 621
 622 struct se_lun_acl {
 623         u64                     mapped_lun;
 624         struct se_node_acl      *se_lun_nacl;
 625         struct se_lun           *se_lun;
 626         struct config_group     se_lun_group;
 627         struct se_ml_stat_grps  ml_stat_grps;
 628 };
 629
 630 struct se_dev_entry {
 631         u64                     mapped_lun;
 632         u64                     pr_res_key;
 633         u64                     creation_time;
 634         bool                    lun_access_ro;
 635         u32                     attach_count;
 636         atomic_long_t           total_cmds;
 637         atomic_long_t           read_bytes;
 638         atomic_long_t           write_bytes;
 639         atomic_t                ua_count;
 640         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 641         struct kref             pr_kref;
 642         struct completion       pr_comp;
 643         struct se_lun_acl __rcu *se_lun_acl;
 644         spinlock_t              ua_lock;
 645         struct se_lun __rcu     *se_lun;
 646 #define DEF_PR_REG_ACTIVE               1
 647         unsigned long           deve_flags;
 648         struct list_head        alua_port_list;
 649         struct list_head        lun_link;
 650         struct list_head        ua_list;
 651         struct hlist_node       link;
 652         struct rcu_head         rcu_head;
 653 };
 654
 655 struct se_dev_attrib {
 656         int             emulate_model_alias;
 657         int             emulate_dpo;
 658         int             emulate_fua_write;
 659         int             emulate_fua_read;
 660         int             emulate_write_cache;
 661         int             emulate_ua_intlck_ctrl;
 662         int             emulate_tas;
 663         int             emulate_tpu;
 664         int             emulate_tpws;
 665         int             emulate_caw;
 666         int             emulate_3pc;
 667         int             pi_prot_format;
 668         enum target_prot_type pi_prot_type;
 669         enum target_prot_type hw_pi_prot_type;
 670         int             enforce_pr_isids;
 671         int             force_pr_aptpl;
 672         int             is_nonrot;
 673         int             emulate_rest_reord;
 674         int             unmap_zeroes_data;
 675         u32             hw_block_size;
 676         u32             block_size;
 677         u32             hw_max_sectors;
 678         u32             optimal_sectors;
 679         u32             hw_queue_depth;
 680         u32             queue_depth;
 681         u32             max_unmap_lba_count;
 682         u32             max_unmap_block_desc_count;
 683         u32             unmap_granularity;
 684         u32             unmap_granularity_alignment;
 685         u32             max_write_same_len;
 686         u32             max_bytes_per_io;
 687         struct se_device *da_dev;
 688         struct config_group da_group;
 689 };
 690
 691 struct se_port_stat_grps {
 692         struct config_group stat_group;
 693         struct config_group scsi_port_group;
 694         struct config_group scsi_tgt_port_group;
 695         struct config_group scsi_transport_group;
 696 };
 697
 698 struct scsi_port_stats {
 699         atomic_long_t   cmd_pdus;
 700         atomic_long_t   tx_data_octets;
 701         atomic_long_t   rx_data_octets;
 702 };
 703
 704 struct se_lun {
 705         u64                     unpacked_lun;
 706 #define SE_LUN_LINK_MAGIC                       0xffff7771
 707         u32                     lun_link_magic;
 708         bool                    lun_access_ro;
 709         u32                     lun_index;
 710
 711         /* RELATIVE TARGET PORT IDENTIFER */
 712         u16                     lun_rtpi;
 713         atomic_t                lun_acl_count;
 714         struct se_device __rcu  *lun_se_dev;
 715
 716         struct list_head        lun_deve_list;
 717         spinlock_t              lun_deve_lock;
 718
 719         /* ALUA state */
 720         int                     lun_tg_pt_secondary_stat;
 721         int                     lun_tg_pt_secondary_write_md;
 722         atomic_t                lun_tg_pt_secondary_offline;
 723         struct mutex            lun_tg_pt_md_mutex;
 724
 725         /* ALUA target port group linkage */
 726         struct list_head        lun_tg_pt_gp_link;
 727         struct t10_alua_tg_pt_gp *lun_tg_pt_gp;
 728         spinlock_t              lun_tg_pt_gp_lock;
 729
 730         struct se_portal_group  *lun_tpg;
 731         struct scsi_port_stats  lun_stats;
 732         struct config_group     lun_group;
 733         struct se_port_stat_grps port_stat_grps;
 734         struct completion       lun_ref_comp;
 735         struct completion       lun_shutdown_comp;
 736         struct percpu_ref       lun_ref;
 737         struct list_head        lun_dev_link;
 738         struct hlist_node       link;
 739         struct rcu_head         rcu_head;
 740 };
 741
 742 struct se_dev_stat_grps {
 743         struct config_group stat_group;
 744         struct config_group scsi_dev_group;
 745         struct config_group scsi_tgt_dev_group;
 746         struct config_group scsi_lu_group;
 747 };
 748
 749 struct se_device {
 750 #define SE_DEV_LINK_MAGIC                       0xfeeddeef
 751         u32                     dev_link_magic;
 752         /* RELATIVE TARGET PORT IDENTIFER Counter */
 753         u16                     dev_rpti_counter;
 754         /* Used for SAM Task Attribute ordering */
 755         u32                     dev_cur_ordered_id;
 756         u32                     dev_flags;
 757 #define DF_CONFIGURED                           0x00000001
 758 #define DF_FIRMWARE_VPD_UNIT_SERIAL             0x00000002
 759 #define DF_EMULATED_VPD_UNIT_SERIAL             0x00000004
 760 #define DF_USING_UDEV_PATH                      0x00000008
 761 #define DF_USING_ALIAS                          0x00000010
 762 #define DF_READ_ONLY                            0x00000020
 763         /* Physical device queue depth */
 764         u32                     queue_depth;
 765         /* Used for SPC-2 reservations enforce of ISIDs */
 766         u64                     dev_res_bin_isid;
 767         /* Pointer to transport specific device structure */
 768         u32                     dev_index;
 769         u64                     creation_time;
 770         atomic_long_t           num_resets;
 771         atomic_long_t           aborts_complete;
 772         atomic_long_t           aborts_no_task;
 773         atomic_long_t           num_cmds;
 774         atomic_long_t           read_bytes;
 775         atomic_long_t           write_bytes;
 776         /* Active commands on this virtual SE device */
 777         atomic_t                simple_cmds;
 778         atomic_t                dev_ordered_sync;
 779         atomic_t                dev_qf_count;
 780         u32                     export_count;
 781         spinlock_t              delayed_cmd_lock;
 782         spinlock_t              execute_task_lock;
 783         spinlock_t              dev_reservation_lock;
 784         unsigned int            dev_reservation_flags;
 785 #define DRF_SPC2_RESERVATIONS                   0x00000001
 786 #define DRF_SPC2_RESERVATIONS_WITH_ISID         0x00000002
 787         spinlock_t              se_port_lock;
 788         spinlock_t              se_tmr_lock;
 789         spinlock_t              qf_cmd_lock;
 790         struct semaphore        caw_sem;
 791         /* Used for legacy SPC-2 reservationsa */
 792         struct se_node_acl      *dev_reserved_node_acl;
 793         /* Used for ALUA Logical Unit Group membership */
 794         struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
 795         /* Used for SPC-3 Persistent Reservations */
 796         struct t10_pr_registration *dev_pr_res_holder;
 797         struct list_head        dev_sep_list;
 798         struct list_head        dev_tmr_list;
 799         struct workqueue_struct *tmr_wq;
 800         struct work_struct      qf_work_queue;
 801         struct list_head        delayed_cmd_list;
 802         struct list_head        state_list;
 803         struct list_head        qf_cmd_list;
 804         struct list_head        g_dev_node;
 805         /* Pointer to associated SE HBA */
 806         struct se_hba           *se_hba;
 807         /* T10 Inquiry and VPD WWN Information */
 808         struct t10_wwn          t10_wwn;
 809         /* T10 Asymmetric Logical Unit Assignment for Target Ports */
 810         struct t10_alua         t10_alua;
 811         /* T10 SPC-2 + SPC-3 Reservations */
 812         struct t10_reservation  t10_pr;
 813         struct se_dev_attrib    dev_attrib;
 814         struct config_group     dev_group;
 815         struct config_group     dev_pr_group;
 816         struct se_dev_stat_grps dev_stat_grps;
 817 #define SE_DEV_ALIAS_LEN 512            /* must be less than PAGE_SIZE */
 818         unsigned char           dev_alias[SE_DEV_ALIAS_LEN];
 819 #define SE_UDEV_PATH_LEN 512            /* must be less than PAGE_SIZE */
 820         unsigned char           udev_path[SE_UDEV_PATH_LEN];
 821         /* Pointer to template of function pointers for transport */
 822         const struct target_backend_ops *transport;
 823         /* Linked list for struct se_hba struct se_device list */
 824         struct list_head        dev_list;
 825         struct se_lun           xcopy_lun;
 826         /* Protection Information */
 827         int                     prot_length;
 828         /* For se_lun->lun_se_dev RCU read-side critical access */
 829         u32                     hba_index;
 830         struct rcu_head         rcu_head;
 831 };
 832
 833 struct se_hba {
 834         u16                     hba_tpgt;
 835         u32                     hba_id;
 836         /* See hba_flags_table */
 837         u32                     hba_flags;
 838         /* Virtual iSCSI devices attached. */
 839         u32                     dev_count;
 840         u32                     hba_index;
 841         /* Pointer to transport specific host structure. */
 842         void                    *hba_ptr;
 843         struct list_head        hba_node;
 844         spinlock_t              device_lock;
 845         struct config_group     hba_group;
 846         struct mutex            hba_access_mutex;
 847         struct target_backend   *backend;
 848 };
 849
 850 struct se_tpg_np {
 851         struct se_portal_group *tpg_np_parent;
 852         struct config_group     tpg_np_group;
 853 };
 854
 855 static inline struct se_tpg_np *to_tpg_np(struct config_item *item)
 856 {
 857         return container_of(to_config_group(item), struct se_tpg_np,
 858                         tpg_np_group);
 859 }
 860
 861 struct se_portal_group {
 862         /*
 863          * PROTOCOL IDENTIFIER value per SPC4, 7.5.1.
 864          *
 865          * Negative values can be used by fabric drivers for internal use TPGs.
 866          */
 867         int                     proto_id;
 868         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 869         atomic_t                tpg_pr_ref_count;
 870         /* Spinlock for adding/removing ACLed Nodes */
 871         struct mutex            acl_node_mutex;
 872         /* Spinlock for adding/removing sessions */
 873         spinlock_t              session_lock;
 874         struct mutex            tpg_lun_mutex;
 875         struct list_head        se_tpg_node;
 876         /* linked list for initiator ACL list */
 877         struct list_head        acl_node_list;
 878         struct hlist_head       tpg_lun_hlist;
 879         struct se_lun           *tpg_virt_lun0;
 880         /* List of TCM sessions associated wth this TPG */
 881         struct list_head        tpg_sess_list;
 882         /* Pointer to $FABRIC_MOD dependent code */
 883         const struct target_core_fabric_ops *se_tpg_tfo;
 884         struct se_wwn           *se_tpg_wwn;
 885         struct config_group     tpg_group;
 886         struct config_group     tpg_lun_group;
 887         struct config_group     tpg_np_group;
 888         struct config_group     tpg_acl_group;
 889         struct config_group     tpg_attrib_group;
 890         struct config_group     tpg_auth_group;
 891         struct config_group     tpg_param_group;
 892 };
 893
 894 static inline struct se_portal_group *to_tpg(struct config_item *item)
 895 {
 896         return container_of(to_config_group(item), struct se_portal_group,
 897                         tpg_group);
 898 }
 899
 900 static inline struct se_portal_group *attrib_to_tpg(struct config_item *item)
 901 {
 902         return container_of(to_config_group(item), struct se_portal_group,
 903                         tpg_attrib_group);
 904 }
 905
 906 static inline struct se_portal_group *auth_to_tpg(struct config_item *item)
 907 {
 908         return container_of(to_config_group(item), struct se_portal_group,
 909                         tpg_auth_group);
 910 }
 911
 912 static inline struct se_portal_group *param_to_tpg(struct config_item *item)
 913 {
 914         return container_of(to_config_group(item), struct se_portal_group,
 915                         tpg_param_group);
 916 }
 917
 918 struct se_wwn {
 919         struct target_fabric_configfs *wwn_tf;
 920         void                    *priv;
 921         struct config_group     wwn_group;
 922         struct config_group     fabric_stat_group;
 923 };
 924
 925 static inline void atomic_inc_mb(atomic_t *v)
 926 {
 927         smp_mb__before_atomic();
 928         atomic_inc(v);
 929         smp_mb__after_atomic();
 930 }
 931
 932 static inline void atomic_dec_mb(atomic_t *v)
 933 {
 934         smp_mb__before_atomic();
 935         atomic_dec(v);
 936         smp_mb__after_atomic();
 937 }
 938
 939 #endif /* TARGET_CORE_BASE_H */