include/target/target_core_fabric.h

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