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