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