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