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