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         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 work_struct 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 se_lun           *tmr_lun;
 404         struct list_head        tmr_list;
 405 };
 406
 407 enum target_prot_op {
 408         TARGET_PROT_NORMAL      = 0,
 409         TARGET_PROT_DIN_INSERT  = (1 << 0),
 410         TARGET_PROT_DOUT_INSERT = (1 << 1),
 411         TARGET_PROT_DIN_STRIP   = (1 << 2),
 412         TARGET_PROT_DOUT_STRIP  = (1 << 3),
 413         TARGET_PROT_DIN_PASS    = (1 << 4),
 414         TARGET_PROT_DOUT_PASS   = (1 << 5),
 415 };
 416
 417 #define TARGET_PROT_ALL TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \
 418                         TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \
 419                         TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS
 420
 421 enum target_prot_type {
 422         TARGET_DIF_TYPE0_PROT,
 423         TARGET_DIF_TYPE1_PROT,
 424         TARGET_DIF_TYPE2_PROT,
 425         TARGET_DIF_TYPE3_PROT,
 426 };
 427
 428 enum target_core_dif_check {
 429         TARGET_DIF_CHECK_GUARD  = 0x1 << 0,
 430         TARGET_DIF_CHECK_APPTAG = 0x1 << 1,
 431         TARGET_DIF_CHECK_REFTAG = 0x1 << 2,
 432 };
 433
 434 /* for sam_task_attr */
 435 #define TCM_SIMPLE_TAG  0x20
 436 #define TCM_HEAD_TAG    0x21
 437 #define TCM_ORDERED_TAG 0x22
 438 #define TCM_ACA_TAG     0x24
 439
 440 struct se_cmd {
 441         /* SAM response code being sent to initiator */
 442         u8                      scsi_status;
 443         u8                      scsi_asc;
 444         u8                      scsi_ascq;
 445         u16                     scsi_sense_length;
 446         unsigned                cmd_wait_set:1;
 447         unsigned                unknown_data_length:1;
 448         bool                    state_active:1;
 449         u64                     tag; /* SAM command identifier aka task tag */
 450         /* Delay for ALUA Active/NonOptimized state access in milliseconds */
 451         int                     alua_nonop_delay;
 452         /* See include/linux/dma-mapping.h */
 453         enum dma_data_direction data_direction;
 454         /* For SAM Task Attribute */
 455         int                     sam_task_attr;
 456         /* Used for se_sess->sess_tag_pool */
 457         unsigned int            map_tag;
 458         /* Transport protocol dependent state, see transport_state_table */
 459         enum transport_state_table t_state;
 460         /* See se_cmd_flags_table */
 461         u32                     se_cmd_flags;
 462         /* Total size in bytes associated with command */
 463         u32                     data_length;
 464         u32                     residual_count;
 465         u64                     orig_fe_lun;
 466         /* Persistent Reservation key */
 467         u64                     pr_res_key;
 468         /* Used for sense data */
 469         void                    *sense_buffer;
 470         struct list_head        se_delayed_node;
 471         struct list_head        se_qf_node;
 472         struct se_device      *se_dev;
 473         struct se_lun           *se_lun;
 474         /* Only used for internal passthrough and legacy TCM fabric modules */
 475         struct se_session       *se_sess;
 476         struct se_tmr_req       *se_tmr_req;
 477         struct list_head        se_cmd_list;
 478         struct completion       cmd_wait_comp;
 479         const struct target_core_fabric_ops *se_tfo;
 480         sense_reason_t          (*execute_cmd)(struct se_cmd *);
 481         sense_reason_t (*transport_complete_callback)(struct se_cmd *, bool, int *);
 482         void                    *protocol_data;
 483
 484         unsigned char           *t_task_cdb;
 485         unsigned char           __t_task_cdb[TCM_MAX_COMMAND_SIZE];
 486         unsigned long long      t_task_lba;
 487         unsigned int            t_task_nolb;
 488         unsigned int            transport_state;
 489 #define CMD_T_ABORTED           (1 << 0)
 490 #define CMD_T_ACTIVE            (1 << 1)
 491 #define CMD_T_COMPLETE          (1 << 2)
 492 #define CMD_T_SENT              (1 << 4)
 493 #define CMD_T_STOP              (1 << 5)
 494 #define CMD_T_DEV_ACTIVE        (1 << 7)
 495 #define CMD_T_REQUEST_STOP      (1 << 8)
 496 #define CMD_T_BUSY              (1 << 9)
 497 #define CMD_T_TAS               (1 << 10)
 498 #define CMD_T_FABRIC_STOP       (1 << 11)
 499         spinlock_t              t_state_lock;
 500         struct kref             cmd_kref;
 501         struct completion       t_transport_stop_comp;
 502
 503         struct work_struct      work;
 504
 505         struct scatterlist      *t_data_sg;
 506         struct scatterlist      *t_data_sg_orig;
 507         unsigned int            t_data_nents;
 508         unsigned int            t_data_nents_orig;
 509         void                    *t_data_vmap;
 510         struct scatterlist      *t_bidi_data_sg;
 511         unsigned int            t_bidi_data_nents;
 512
 513         /* Used for lun->lun_ref counting */
 514         int                     lun_ref_active;
 515
 516         struct list_head        state_list;
 517
 518         /* old task stop completion, consider merging with some of the above */
 519         struct completion       task_stop_comp;
 520
 521         /* backend private data */
 522         void                    *priv;
 523
 524         /* DIF related members */
 525         enum target_prot_op     prot_op;
 526         enum target_prot_type   prot_type;
 527         u8                      prot_checks;
 528         bool                    prot_pto;
 529         u32                     prot_length;
 530         u32                     reftag_seed;
 531         struct scatterlist      *t_prot_sg;
 532         unsigned int            t_prot_nents;
 533         sense_reason_t          pi_err;
 534         sector_t                bad_sector;
 535 };
 536
 537 struct se_ua {
 538         u8                      ua_asc;
 539         u8                      ua_ascq;
 540         struct list_head        ua_nacl_list;
 541 };
 542
 543 struct se_node_acl {
 544         char                    initiatorname[TRANSPORT_IQN_LEN];
 545         /* Used to signal demo mode created ACL, disabled by default */
 546         bool                    dynamic_node_acl;
 547         bool                    acl_stop:1;
 548         bool                    dynamic_stop;
 549         u32                     queue_depth;
 550         u32                     acl_index;
 551         enum target_prot_type   saved_prot_type;
 552 #define MAX_ACL_TAG_SIZE 64
 553         char                    acl_tag[MAX_ACL_TAG_SIZE];
 554         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 555         atomic_t                acl_pr_ref_count;
 556         struct hlist_head       lun_entry_hlist;
 557         struct se_session       *nacl_sess;
 558         struct se_portal_group *se_tpg;
 559         struct mutex            lun_entry_mutex;
 560         spinlock_t              nacl_sess_lock;
 561         struct config_group     acl_group;
 562         struct config_group     acl_attrib_group;
 563         struct config_group     acl_auth_group;
 564         struct config_group     acl_param_group;
 565         struct config_group     acl_fabric_stat_group;
 566         struct config_group     *acl_default_groups[5];
 567         struct list_head        acl_list;
 568         struct list_head        acl_sess_list;
 569         struct completion       acl_free_comp;
 570         struct kref             acl_kref;
 571 };
 572
 573 static inline struct se_node_acl *acl_to_nacl(struct config_item *item)
 574 {
 575         return container_of(to_config_group(item), struct se_node_acl,
 576                         acl_group);
 577 }
 578
 579 static inline struct se_node_acl *attrib_to_nacl(struct config_item *item)
 580 {
 581         return container_of(to_config_group(item), struct se_node_acl,
 582                         acl_attrib_group);
 583 }
 584
 585 static inline struct se_node_acl *auth_to_nacl(struct config_item *item)
 586 {
 587         return container_of(to_config_group(item), struct se_node_acl,
 588                         acl_auth_group);
 589 }
 590
 591 static inline struct se_node_acl *param_to_nacl(struct config_item *item)
 592 {
 593         return container_of(to_config_group(item), struct se_node_acl,
 594                         acl_param_group);
 595 }
 596
 597 static inline struct se_node_acl *fabric_stat_to_nacl(struct config_item *item)
 598 {
 599         return container_of(to_config_group(item), struct se_node_acl,
 600                         acl_fabric_stat_group);
 601 }
 602
 603 struct se_session {
 604         unsigned                sess_tearing_down:1;
 605         u64                     sess_bin_isid;
 606         enum target_prot_op     sup_prot_ops;
 607         enum target_prot_type   sess_prot_type;
 608         struct se_node_acl      *se_node_acl;
 609         struct se_portal_group *se_tpg;
 610         void                    *fabric_sess_ptr;
 611         struct list_head        sess_list;
 612         struct list_head        sess_acl_list;
 613         struct list_head        sess_cmd_list;
 614         struct list_head        sess_wait_list;
 615         spinlock_t              sess_cmd_lock;
 616         struct kref             sess_kref;
 617         void                    *sess_cmd_map;
 618         struct percpu_ida       sess_tag_pool;
 619 };
 620
 621 struct se_device;
 622 struct se_transform_info;
 623 struct scatterlist;
 624
 625 struct se_ml_stat_grps {
 626         struct config_group     stat_group;
 627         struct config_group     scsi_auth_intr_group;
 628         struct config_group     scsi_att_intr_port_group;
 629 };
 630
 631 struct se_lun_acl {
 632         u64                     mapped_lun;
 633         struct se_node_acl      *se_lun_nacl;
 634         struct se_lun           *se_lun;
 635         struct config_group     se_lun_group;
 636         struct se_ml_stat_grps  ml_stat_grps;
 637 };
 638
 639 struct se_dev_entry {
 640         /* See transport_lunflags_table */
 641         u64                     mapped_lun;
 642         u64                     pr_res_key;
 643         u64                     creation_time;
 644         u32                     lun_flags;
 645         u32                     attach_count;
 646         atomic_long_t           total_cmds;
 647         atomic_long_t           read_bytes;
 648         atomic_long_t           write_bytes;
 649         atomic_t                ua_count;
 650         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 651         struct kref             pr_kref;
 652         struct completion       pr_comp;
 653         struct se_lun_acl __rcu *se_lun_acl;
 654         spinlock_t              ua_lock;
 655         struct se_lun __rcu     *se_lun;
 656 #define DEF_PR_REG_ACTIVE               1
 657         unsigned long           deve_flags;
 658         struct list_head        alua_port_list;
 659         struct list_head        lun_link;
 660         struct list_head        ua_list;
 661         struct hlist_node       link;
 662         struct rcu_head         rcu_head;
 663 };
 664
 665 struct se_dev_attrib {
 666         int             emulate_model_alias;
 667         int             emulate_dpo;
 668         int             emulate_fua_write;
 669         int             emulate_fua_read;
 670         int             emulate_write_cache;
 671         int             emulate_ua_intlck_ctrl;
 672         int             emulate_tas;
 673         int             emulate_tpu;
 674         int             emulate_tpws;
 675         int             emulate_caw;
 676         int             emulate_3pc;
 677         int             pi_prot_format;
 678         enum target_prot_type pi_prot_type;
 679         enum target_prot_type hw_pi_prot_type;
 680         int             enforce_pr_isids;
 681         int             force_pr_aptpl;
 682         int             is_nonrot;
 683         int             emulate_rest_reord;
 684         u32             hw_block_size;
 685         u32             block_size;
 686         u32             hw_max_sectors;
 687         u32             optimal_sectors;
 688         u32             hw_queue_depth;
 689         u32             queue_depth;
 690         u32             max_unmap_lba_count;
 691         u32             max_unmap_block_desc_count;
 692         u32             unmap_granularity;
 693         u32             unmap_granularity_alignment;
 694         u32             max_write_same_len;
 695         u32             max_bytes_per_io;
 696         struct se_device *da_dev;
 697         struct config_group da_group;
 698 };
 699
 700 struct se_port_stat_grps {
 701         struct config_group stat_group;
 702         struct config_group scsi_port_group;
 703         struct config_group scsi_tgt_port_group;
 704         struct config_group scsi_transport_group;
 705 };
 706
 707 struct scsi_port_stats {
 708         atomic_long_t   cmd_pdus;
 709         atomic_long_t   tx_data_octets;
 710         atomic_long_t   rx_data_octets;
 711 };
 712
 713 struct se_lun {
 714         u64                     unpacked_lun;
 715 #define SE_LUN_LINK_MAGIC                       0xffff7771
 716         u32                     lun_link_magic;
 717         u32                     lun_access;
 718         bool                    lun_shutdown;
 719         u32                     lun_index;
 720
 721         /* RELATIVE TARGET PORT IDENTIFER */
 722         u16                     lun_rtpi;
 723         atomic_t                lun_acl_count;
 724         struct se_device __rcu  *lun_se_dev;
 725
 726         struct list_head        lun_deve_list;
 727         spinlock_t              lun_deve_lock;
 728
 729         /* ALUA state */
 730         int                     lun_tg_pt_secondary_stat;
 731         int                     lun_tg_pt_secondary_write_md;
 732         atomic_t                lun_tg_pt_secondary_offline;
 733         struct mutex            lun_tg_pt_md_mutex;
 734
 735         /* ALUA target port group linkage */
 736         struct list_head        lun_tg_pt_gp_link;
 737         struct t10_alua_tg_pt_gp *lun_tg_pt_gp;
 738         spinlock_t              lun_tg_pt_gp_lock;
 739
 740         struct se_portal_group  *lun_tpg;
 741         struct scsi_port_stats  lun_stats;
 742         struct config_group     lun_group;
 743         struct se_port_stat_grps port_stat_grps;
 744         struct completion       lun_ref_comp;
 745         struct completion       lun_shutdown_comp;
 746         struct percpu_ref       lun_ref;
 747         struct list_head        lun_dev_link;
 748         struct hlist_node       link;
 749         struct rcu_head         rcu_head;
 750 };
 751
 752 struct se_dev_stat_grps {
 753         struct config_group stat_group;
 754         struct config_group scsi_dev_group;
 755         struct config_group scsi_tgt_dev_group;
 756         struct config_group scsi_lu_group;
 757 };
 758
 759 struct se_device {
 760 #define SE_DEV_LINK_MAGIC                       0xfeeddeef
 761         u32                     dev_link_magic;
 762         /* RELATIVE TARGET PORT IDENTIFER Counter */
 763         u16                     dev_rpti_counter;
 764         /* Used for SAM Task Attribute ordering */
 765         u32                     dev_cur_ordered_id;
 766         u32                     dev_flags;
 767 #define DF_CONFIGURED                           0x00000001
 768 #define DF_FIRMWARE_VPD_UNIT_SERIAL             0x00000002
 769 #define DF_EMULATED_VPD_UNIT_SERIAL             0x00000004
 770 #define DF_USING_UDEV_PATH                      0x00000008
 771 #define DF_USING_ALIAS                          0x00000010
 772 #define DF_READ_ONLY                            0x00000020
 773         /* Physical device queue depth */
 774         u32                     queue_depth;
 775         /* Used for SPC-2 reservations enforce of ISIDs */
 776         u64                     dev_res_bin_isid;
 777         /* Pointer to transport specific device structure */
 778         u32                     dev_index;
 779         u64                     creation_time;
 780         atomic_long_t           num_resets;
 781         atomic_long_t           num_cmds;
 782         atomic_long_t           read_bytes;
 783         atomic_long_t           write_bytes;
 784         /* Active commands on this virtual SE device */
 785         atomic_t                simple_cmds;
 786         atomic_t                dev_ordered_sync;
 787         atomic_t                dev_qf_count;
 788         u32                     export_count;
 789         spinlock_t              delayed_cmd_lock;
 790         spinlock_t              execute_task_lock;
 791         spinlock_t              dev_reservation_lock;
 792         unsigned int            dev_reservation_flags;
 793 #define DRF_SPC2_RESERVATIONS                   0x00000001
 794 #define DRF_SPC2_RESERVATIONS_WITH_ISID         0x00000002
 795         spinlock_t              se_port_lock;
 796         spinlock_t              se_tmr_lock;
 797         spinlock_t              qf_cmd_lock;
 798         struct semaphore        caw_sem;
 799         /* Used for legacy SPC-2 reservationsa */
 800         struct se_node_acl      *dev_reserved_node_acl;
 801         /* Used for ALUA Logical Unit Group membership */
 802         struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem;
 803         /* Used for SPC-3 Persistent Reservations */
 804         struct t10_pr_registration *dev_pr_res_holder;
 805         struct list_head        dev_sep_list;
 806         struct list_head        dev_tmr_list;
 807         struct workqueue_struct *tmr_wq;
 808         struct work_struct      qf_work_queue;
 809         struct list_head        delayed_cmd_list;
 810         struct list_head        state_list;
 811         struct list_head        qf_cmd_list;
 812         struct list_head        g_dev_node;
 813         /* Pointer to associated SE HBA */
 814         struct se_hba           *se_hba;
 815         /* T10 Inquiry and VPD WWN Information */
 816         struct t10_wwn          t10_wwn;
 817         /* T10 Asymmetric Logical Unit Assignment for Target Ports */
 818         struct t10_alua         t10_alua;
 819         /* T10 SPC-2 + SPC-3 Reservations */
 820         struct t10_reservation  t10_pr;
 821         struct se_dev_attrib    dev_attrib;
 822         struct config_group     dev_group;
 823         struct config_group     dev_pr_group;
 824         struct se_dev_stat_grps dev_stat_grps;
 825 #define SE_DEV_ALIAS_LEN 512            /* must be less than PAGE_SIZE */
 826         unsigned char           dev_alias[SE_DEV_ALIAS_LEN];
 827 #define SE_UDEV_PATH_LEN 512            /* must be less than PAGE_SIZE */
 828         unsigned char           udev_path[SE_UDEV_PATH_LEN];
 829         /* Pointer to template of function pointers for transport */
 830         const struct target_backend_ops *transport;
 831         /* Linked list for struct se_hba struct se_device list */
 832         struct list_head        dev_list;
 833         struct se_lun           xcopy_lun;
 834         /* Protection Information */
 835         int                     prot_length;
 836         /* For se_lun->lun_se_dev RCU read-side critical access */
 837         u32                     hba_index;
 838         struct rcu_head         rcu_head;
 839 };
 840
 841 struct se_hba {
 842         u16                     hba_tpgt;
 843         u32                     hba_id;
 844         /* See hba_flags_table */
 845         u32                     hba_flags;
 846         /* Virtual iSCSI devices attached. */
 847         u32                     dev_count;
 848         u32                     hba_index;
 849         /* Pointer to transport specific host structure. */
 850         void                    *hba_ptr;
 851         struct list_head        hba_node;
 852         spinlock_t              device_lock;
 853         struct config_group     hba_group;
 854         struct mutex            hba_access_mutex;
 855         struct target_backend   *backend;
 856 };
 857
 858 struct se_tpg_np {
 859         struct se_portal_group *tpg_np_parent;
 860         struct config_group     tpg_np_group;
 861 };
 862
 863 static inline struct se_tpg_np *to_tpg_np(struct config_item *item)
 864 {
 865         return container_of(to_config_group(item), struct se_tpg_np,
 866                         tpg_np_group);
 867 }
 868
 869 struct se_portal_group {
 870         /*
 871          * PROTOCOL IDENTIFIER value per SPC4, 7.5.1.
 872          *
 873          * Negative values can be used by fabric drivers for internal use TPGs.
 874          */
 875         int                     proto_id;
 876         /* Number of ACLed Initiator Nodes for this TPG */
 877         u32                     num_node_acls;
 878         /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */
 879         atomic_t                tpg_pr_ref_count;
 880         /* Spinlock for adding/removing ACLed Nodes */
 881         struct mutex            acl_node_mutex;
 882         /* Spinlock for adding/removing sessions */
 883         spinlock_t              session_lock;
 884         struct mutex            tpg_lun_mutex;
 885         struct list_head        se_tpg_node;
 886         /* linked list for initiator ACL list */
 887         struct list_head        acl_node_list;
 888         struct hlist_head       tpg_lun_hlist;
 889         struct se_lun           *tpg_virt_lun0;
 890         /* List of TCM sessions associated wth this TPG */
 891         struct list_head        tpg_sess_list;
 892         /* Pointer to $FABRIC_MOD dependent code */
 893         const struct target_core_fabric_ops *se_tpg_tfo;
 894         struct se_wwn           *se_tpg_wwn;
 895         struct config_group     tpg_group;
 896         struct config_group     *tpg_default_groups[7];
 897         struct config_group     tpg_lun_group;
 898         struct config_group     tpg_np_group;
 899         struct config_group     tpg_acl_group;
 900         struct config_group     tpg_attrib_group;
 901         struct config_group     tpg_auth_group;
 902         struct config_group     tpg_param_group;
 903 };
 904
 905 static inline struct se_portal_group *to_tpg(struct config_item *item)
 906 {
 907         return container_of(to_config_group(item), struct se_portal_group,
 908                         tpg_group);
 909 }
 910
 911 static inline struct se_portal_group *attrib_to_tpg(struct config_item *item)
 912 {
 913         return container_of(to_config_group(item), struct se_portal_group,
 914                         tpg_attrib_group);
 915 }
 916
 917 static inline struct se_portal_group *auth_to_tpg(struct config_item *item)
 918 {
 919         return container_of(to_config_group(item), struct se_portal_group,
 920                         tpg_auth_group);
 921 }
 922
 923 static inline struct se_portal_group *param_to_tpg(struct config_item *item)
 924 {
 925         return container_of(to_config_group(item), struct se_portal_group,
 926                         tpg_param_group);
 927 }
 928
 929 struct se_wwn {
 930         struct target_fabric_configfs *wwn_tf;
 931         struct config_group     wwn_group;
 932         struct config_group     *wwn_default_groups[2];
 933         struct config_group     fabric_stat_group;
 934 };
 935
 936 static inline void atomic_inc_mb(atomic_t *v)
 937 {
 938         smp_mb__before_atomic();
 939         atomic_inc(v);
 940         smp_mb__after_atomic();
 941 }
 942
 943 static inline void atomic_dec_mb(atomic_t *v)
 944 {
 945         smp_mb__before_atomic();
 946         atomic_dec(v);
 947         smp_mb__after_atomic();
 948 }
 949
 950 #endif /* TARGET_CORE_BASE_H */