include/target/target_core_base.h

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