LXR linux/include/target/target_core

   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef TARGET_CORE_FABRIC_H
   3#define TARGET_CORE_FABRIC_H
   4
   5#include <linux/configfs.h>
   6#include <linux/types.h>
   7#include <target/target_core_base.h>
   8
   9struct target_core_fabric_ops {
  10        struct module *module;
  11        const char *name;
  12        size_t node_acl_size;
  13        /*
  14         * Limits number of scatterlist entries per SCF_SCSI_DATA_CDB payload.
  15         * Setting this value tells target-core to enforce this limit, and
  16         * report as INQUIRY EVPD=b0 MAXIMUM TRANSFER LENGTH.
  17         *
  18         * target-core will currently reset se_cmd->data_length to this
  19         * maximum size, and set UNDERFLOW residual count if length exceeds
  20         * this limit.
  21         *
  22         * XXX: Not all initiator hosts honor this block-limit EVPD
  23         * XXX: Currently assumes single PAGE_SIZE per scatterlist entry
  24         */
  25        u32 max_data_sg_nents;
  26        char *(*get_fabric_name)(void);
  27        char *(*tpg_get_wwn)(struct se_portal_group *);
  28        u16 (*tpg_get_tag)(struct se_portal_group *);
  29        u32 (*tpg_get_default_depth)(struct se_portal_group *);
  30        int (*tpg_check_demo_mode)(struct se_portal_group *);
  31        int (*tpg_check_demo_mode_cache)(struct se_portal_group *);
  32        int (*tpg_check_demo_mode_write_protect)(struct se_portal_group *);
  33        int (*tpg_check_prod_mode_write_protect)(struct se_portal_group *);
  34        /*
  35         * Optionally used by fabrics to allow demo-mode login, but not
  36         * expose any TPG LUNs, and return 'not connected' in standard
  37         * inquiry response
  38         */
  39        int (*tpg_check_demo_mode_login_only)(struct se_portal_group *);
  40        /*
  41         * Optionally used as a configfs tunable to determine when
  42         * target-core should signal the PROTECT=1 feature bit for
  43         * backends that don't support T10-PI, so that either fabric
  44         * HW offload or target-core emulation performs the associated
  45         * WRITE_STRIP and READ_INSERT operations.
  46         */
  47        int (*tpg_check_prot_fabric_only)(struct se_portal_group *);
  48        u32 (*tpg_get_inst_index)(struct se_portal_group *);
  49        /*
  50         * Optional to release struct se_cmd and fabric dependent allocated
  51         * I/O descriptor after command execution has finished.
  52         *
  53         * Returning 1 will signal a descriptor has been released.
  54         * Returning 0 will signal a descriptor has not been released.
  55         */
  56        int (*check_stop_free)(struct se_cmd *);
  57        void (*release_cmd)(struct se_cmd *);
  58        void (*close_session)(struct se_session *);
  59        u32 (*sess_get_index)(struct se_session *);
  60        /*
  61         * Used only for SCSI fabrics that contain multi-value TransportIDs
  62         * (like iSCSI).  All other SCSI fabrics should set this to NULL.
  63         */
  64        u32 (*sess_get_initiator_sid)(struct se_session *,
  65                                      unsigned char *, u32);
  66        int (*write_pending)(struct se_cmd *);
  67        int (*write_pending_status)(struct se_cmd *);
  68        void (*set_default_node_attributes)(struct se_node_acl *);
  69        int (*get_cmd_state)(struct se_cmd *);
  70        int (*queue_data_in)(struct se_cmd *);
  71        int (*queue_status)(struct se_cmd *);
  72        void (*queue_tm_rsp)(struct se_cmd *);
  73        void (*aborted_task)(struct se_cmd *);
  74        /*
  75         * fabric module calls for target_core_fabric_configfs.c
  76         */
  77        struct se_wwn *(*fabric_make_wwn)(struct target_fabric_configfs *,
  78                                struct config_group *, const char *);
  79        void (*fabric_drop_wwn)(struct se_wwn *);
  80        void (*add_wwn_groups)(struct se_wwn *);
  81        struct se_portal_group *(*fabric_make_tpg)(struct se_wwn *,
  82                                struct config_group *, const char *);
  83        void (*fabric_drop_tpg)(struct se_portal_group *);
  84        int (*fabric_post_link)(struct se_portal_group *,
  85                                struct se_lun *);
  86        void (*fabric_pre_unlink)(struct se_portal_group *,
  87                                struct se_lun *);
  88        struct se_tpg_np *(*fabric_make_np)(struct se_portal_group *,
  89                                struct config_group *, const char *);
  90        void (*fabric_drop_np)(struct se_tpg_np *);
  91        int (*fabric_init_nodeacl)(struct se_node_acl *, const char *);
  92
  93        struct configfs_attribute **tfc_discovery_attrs;
  94        struct configfs_attribute **tfc_wwn_attrs;
  95        struct configfs_attribute **tfc_tpg_base_attrs;
  96        struct configfs_attribute **tfc_tpg_np_base_attrs;
  97        struct configfs_attribute **tfc_tpg_attrib_attrs;
  98        struct configfs_attribute **tfc_tpg_auth_attrs;
  99        struct configfs_attribute **tfc_tpg_param_attrs;
 100        struct configfs_attribute **tfc_tpg_nacl_base_attrs;
 101        struct configfs_attribute **tfc_tpg_nacl_attrib_attrs;
 102        struct configfs_attribute **tfc_tpg_nacl_auth_attrs;
 103        struct configfs_attribute **tfc_tpg_nacl_param_attrs;
 104};
 105
 106int target_register_template(const struct target_core_fabric_ops *fo);
 107void target_unregister_template(const struct target_core_fabric_ops *fo);
 108
 109int target_depend_item(struct config_item *item);
 110void target_undepend_item(struct config_item *item);
 111
 112struct se_session *target_alloc_session(struct se_portal_group *,
 113                unsigned int, unsigned int, enum target_prot_op prot_op,
 114                const char *, void *,
 115                int (*callback)(struct se_portal_group *,
 116                                struct se_session *, void *));
 117
 118struct se_session *transport_init_session(enum target_prot_op);
 119int transport_alloc_session_tags(struct se_session *, unsigned int,
 120                unsigned int);
 121struct se_session *transport_init_session_tags(unsigned int, unsigned int,
 122                enum target_prot_op);
 123void    __transport_register_session(struct se_portal_group *,
 124                struct se_node_acl *, struct se_session *, void *);
 125void    transport_register_session(struct se_portal_group *,
 126                struct se_node_acl *, struct se_session *, void *);
 127ssize_t target_show_dynamic_sessions(struct se_portal_group *, char *);
 128void    transport_free_session(struct se_session *);
 129void    target_put_nacl(struct se_node_acl *);
 130void    transport_deregister_session_configfs(struct se_session *);
 131void    transport_deregister_session(struct se_session *);
 132
 133
 134void    transport_init_se_cmd(struct se_cmd *,
 135                const struct target_core_fabric_ops *,
 136                struct se_session *, u32, int, int, unsigned char *);
 137sense_reason_t transport_lookup_cmd_lun(struct se_cmd *, u64);
 138sense_reason_t target_setup_cmd_from_cdb(struct se_cmd *, unsigned char *);
 139int     target_submit_cmd_map_sgls(struct se_cmd *, struct se_session *,
 140                unsigned char *, unsigned char *, u64, u32, int, int, int,
 141                struct scatterlist *, u32, struct scatterlist *, u32,
 142                struct scatterlist *, u32);
 143int     target_submit_cmd(struct se_cmd *, struct se_session *, unsigned char *,
 144                unsigned char *, u64, u32, int, int, int);
 145int     target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
 146                unsigned char *sense, u64 unpacked_lun,
 147                void *fabric_tmr_ptr, unsigned char tm_type,
 148                gfp_t, u64, int);
 149int     transport_handle_cdb_direct(struct se_cmd *);
 150sense_reason_t  transport_generic_new_cmd(struct se_cmd *);
 151
 152void    target_execute_cmd(struct se_cmd *cmd);
 153
 154int     transport_generic_free_cmd(struct se_cmd *, int);
 155
 156bool    transport_wait_for_tasks(struct se_cmd *);
 157int     transport_check_aborted_status(struct se_cmd *, int);
 158int     transport_send_check_condition_and_sense(struct se_cmd *,
 159                sense_reason_t, int);
 160int     target_get_sess_cmd(struct se_cmd *, bool);
 161int     target_put_sess_cmd(struct se_cmd *);
 162void    target_sess_cmd_list_set_waiting(struct se_session *);
 163void    target_wait_for_sess_cmds(struct se_session *);
 164void    target_show_cmd(const char *pfx, struct se_cmd *cmd);
 165
 166int     core_alua_check_nonop_delay(struct se_cmd *);
 167
 168int     core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
 169void    core_tmr_release_req(struct se_tmr_req *);
 170int     transport_generic_handle_tmr(struct se_cmd *);
 171void    transport_generic_request_failure(struct se_cmd *, sense_reason_t);
 172int     transport_lookup_tmr_lun(struct se_cmd *, u64);
 173void    core_allocate_nexus_loss_ua(struct se_node_acl *acl);
 174
 175struct se_node_acl *core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
 176                unsigned char *);
 177bool    target_tpg_has_node_acl(struct se_portal_group *tpg,
 178                const char *);
 179struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
 180                unsigned char *);
 181int     core_tpg_set_initiator_node_queue_depth(struct se_node_acl *, u32);
 182int     core_tpg_set_initiator_node_tag(struct se_portal_group *,
 183                struct se_node_acl *, const char *);
 184int     core_tpg_register(struct se_wwn *, struct se_portal_group *, int);
 185int     core_tpg_deregister(struct se_portal_group *);
 186
 187int     target_alloc_sgl(struct scatterlist **sgl, unsigned int *nents,
 188                u32 length, bool zero_page, bool chainable);
 189void    target_free_sgl(struct scatterlist *sgl, int nents);
 190
 191/*
 192 * The LIO target core uses DMA_TO_DEVICE to mean that data is going
 193 * to the target (eg handling a WRITE) and DMA_FROM_DEVICE to mean
 194 * that data is coming from the target (eg handling a READ).  However,
 195 * this is just the opposite of what we have to tell the DMA mapping
 196 * layer -- eg when handling a READ, the HBA will have to DMA the data
 197 * out of memory so it can send it to the initiator, which means we
 198 * need to use DMA_TO_DEVICE when we map the data.
 199 */
 200static inline enum dma_data_direction
 201target_reverse_dma_direction(struct se_cmd *se_cmd)
 202{
 203        if (se_cmd->se_cmd_flags & SCF_BIDI)
 204                return DMA_BIDIRECTIONAL;
 205
 206        switch (se_cmd->data_direction) {
 207        case DMA_TO_DEVICE:
 208                return DMA_FROM_DEVICE;
 209        case DMA_FROM_DEVICE:
 210                return DMA_TO_DEVICE;
 211        case DMA_NONE:
 212        default:
 213                return DMA_NONE;
 214        }
 215}
 216
 217#endif /* TARGET_CORE_FABRICH */
 218