include/target/target_core_transport.h

   1 #ifndef TARGET_CORE_TRANSPORT_H
   2 #define TARGET_CORE_TRANSPORT_H
   3
   4 #define TARGET_CORE_VERSION                     TARGET_CORE_MOD_VERSION
   5
   6 /* Attempts before moving from SHORT to LONG */
   7 #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD   3
   8 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT  3  /* In milliseconds */
   9 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG   10 /* In milliseconds */
  10
  11 #define PYX_TRANSPORT_STATUS_INTERVAL           5 /* In seconds */
  12
  13 #define PYX_TRANSPORT_SENT_TO_TRANSPORT         0
  14 #define PYX_TRANSPORT_WRITE_PENDING             1
  15
  16 #define PYX_TRANSPORT_UNKNOWN_SAM_OPCODE        -1
  17 #define PYX_TRANSPORT_HBA_QUEUE_FULL            -2
  18 #define PYX_TRANSPORT_REQ_TOO_MANY_SECTORS      -3
  19 #define PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES   -4
  20 #define PYX_TRANSPORT_INVALID_CDB_FIELD         -5
  21 #define PYX_TRANSPORT_INVALID_PARAMETER_LIST    -6
  22 #define PYX_TRANSPORT_LU_COMM_FAILURE           -7
  23 #define PYX_TRANSPORT_UNKNOWN_MODE_PAGE         -8
  24 #define PYX_TRANSPORT_WRITE_PROTECTED           -9
  25 #define PYX_TRANSPORT_RESERVATION_CONFLICT      -10
  26 #define PYX_TRANSPORT_ILLEGAL_REQUEST           -11
  27 #define PYX_TRANSPORT_USE_SENSE_REASON          -12
  28
  29 #ifndef SAM_STAT_RESERVATION_CONFLICT
  30 #define SAM_STAT_RESERVATION_CONFLICT           0x18
  31 #endif
  32
  33 #define TRANSPORT_PLUGIN_FREE                   0
  34 #define TRANSPORT_PLUGIN_REGISTERED             1
  35
  36 #define TRANSPORT_PLUGIN_PHBA_PDEV              1
  37 #define TRANSPORT_PLUGIN_VHBA_PDEV              2
  38 #define TRANSPORT_PLUGIN_VHBA_VDEV              3
  39
  40 /*
  41  * struct se_subsystem_dev->su_dev_flags
  42 */
  43 #define SDF_FIRMWARE_VPD_UNIT_SERIAL            0x00000001
  44 #define SDF_EMULATED_VPD_UNIT_SERIAL            0x00000002
  45 #define SDF_USING_UDEV_PATH                     0x00000004
  46 #define SDF_USING_ALIAS                         0x00000008
  47
  48 /*
  49  * struct se_device->dev_flags
  50  */
  51 #define DF_READ_ONLY                            0x00000001
  52 #define DF_SPC2_RESERVATIONS                    0x00000002
  53 #define DF_SPC2_RESERVATIONS_WITH_ISID          0x00000004
  54
  55 /* struct se_dev_attrib sanity values */
  56 /* Default max_unmap_lba_count */
  57 #define DA_MAX_UNMAP_LBA_COUNT                  0
  58 /* Default max_unmap_block_desc_count */
  59 #define DA_MAX_UNMAP_BLOCK_DESC_COUNT           0
  60 /* Default unmap_granularity */
  61 #define DA_UNMAP_GRANULARITY_DEFAULT            0
  62 /* Default unmap_granularity_alignment */
  63 #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT  0
  64 /* Emulation for Direct Page Out */
  65 #define DA_EMULATE_DPO                          0
  66 /* Emulation for Forced Unit Access WRITEs */
  67 #define DA_EMULATE_FUA_WRITE                    1
  68 /* Emulation for Forced Unit Access READs */
  69 #define DA_EMULATE_FUA_READ                     0
  70 /* Emulation for WriteCache and SYNCHRONIZE_CACHE */
  71 #define DA_EMULATE_WRITE_CACHE                  0
  72 /* Emulation for UNIT ATTENTION Interlock Control */
  73 #define DA_EMULATE_UA_INTLLCK_CTRL              0
  74 /* Emulation for TASK_ABORTED status (TAS) by default */
  75 #define DA_EMULATE_TAS                          1
  76 /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
  77 #define DA_EMULATE_TPU                          0
  78 /*
  79  * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
  80  * block/blk-lib.c:blkdev_issue_discard()
  81  */
  82 #define DA_EMULATE_TPWS                         0
  83 /* No Emulation for PSCSI by default */
  84 #define DA_EMULATE_RESERVATIONS                 0
  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 #define DA_STATUS_MAX_SECTORS_MIN               16
  90 #define DA_STATUS_MAX_SECTORS_MAX               8192
  91 /* By default don't report non-rotating (solid state) medium */
  92 #define DA_IS_NONROT                            0
  93 /* Queue Algorithm Modifier default for restricted reordering in control mode page */
  94 #define DA_EMULATE_REST_REORD                   0
  95
  96 #define SE_MODE_PAGE_BUF                        512
  97
  98 #define MOD_MAX_SECTORS(ms, bs)                 (ms % (PAGE_SIZE / bs))
  99
 100 struct se_subsystem_api;
 101
 102 extern int init_se_kmem_caches(void);
 103 extern void release_se_kmem_caches(void);
 104 extern u32 scsi_get_new_index(scsi_index_t);
 105 extern void transport_init_queue_obj(struct se_queue_obj *);
 106 extern void transport_subsystem_check_init(void);
 107 extern int transport_subsystem_register(struct se_subsystem_api *);
 108 extern void transport_subsystem_release(struct se_subsystem_api *);
 109 extern void transport_load_plugins(void);
 110 extern struct se_session *transport_init_session(void);
 111 extern void __transport_register_session(struct se_portal_group *,
 112                                         struct se_node_acl *,
 113                                         struct se_session *, void *);
 114 extern void transport_register_session(struct se_portal_group *,
 115                                         struct se_node_acl *,
 116                                         struct se_session *, void *);
 117 extern void transport_free_session(struct se_session *);
 118 extern void transport_deregister_session_configfs(struct se_session *);
 119 extern void transport_deregister_session(struct se_session *);
 120 extern void transport_cmd_finish_abort(struct se_cmd *, int);
 121 extern void transport_complete_sync_cache(struct se_cmd *, int);
 122 extern void transport_complete_task(struct se_task *, int);
 123 extern void transport_add_task_to_execute_queue(struct se_task *,
 124                                                 struct se_task *,
 125                                                 struct se_device *);
 126 extern void transport_remove_task_from_execute_queue(struct se_task *,
 127                                                 struct se_device *);
 128 extern void __transport_remove_task_from_execute_queue(struct se_task *,
 129                                                 struct se_device *);
 130 unsigned char *transport_dump_cmd_direction(struct se_cmd *);
 131 extern void transport_dump_dev_state(struct se_device *, char *, int *);
 132 extern void transport_dump_dev_info(struct se_device *, struct se_lun *,
 133                                         unsigned long long, char *, int *);
 134 extern void transport_dump_vpd_proto_id(struct t10_vpd *,
 135                                         unsigned char *, int);
 136 extern void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
 137 extern int transport_dump_vpd_assoc(struct t10_vpd *,
 138                                         unsigned char *, int);
 139 extern int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
 140 extern int transport_dump_vpd_ident_type(struct t10_vpd *,
 141                                         unsigned char *, int);
 142 extern int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
 143 extern int transport_dump_vpd_ident(struct t10_vpd *,
 144                                         unsigned char *, int);
 145 extern int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
 146 extern struct se_device *transport_add_device_to_core_hba(struct se_hba *,
 147                                         struct se_subsystem_api *,
 148                                         struct se_subsystem_dev *, u32,
 149                                         void *, struct se_dev_limits *,
 150                                         const char *, const char *);
 151 extern void transport_init_se_cmd(struct se_cmd *,
 152                                         struct target_core_fabric_ops *,
 153                                         struct se_session *, u32, int, int,
 154                                         unsigned char *);
 155 void *transport_kmap_first_data_page(struct se_cmd *cmd);
 156 void transport_kunmap_first_data_page(struct se_cmd *cmd);
 157 extern int transport_generic_allocate_tasks(struct se_cmd *, unsigned char *);
 158 extern int transport_handle_cdb_direct(struct se_cmd *);
 159 extern int transport_generic_handle_cdb_map(struct se_cmd *);
 160 extern int transport_generic_handle_data(struct se_cmd *);
 161 extern void transport_new_cmd_failure(struct se_cmd *);
 162 extern int transport_generic_handle_tmr(struct se_cmd *);
 163 extern void transport_generic_free_cmd_intr(struct se_cmd *);
 164 extern bool target_stop_task(struct se_task *task, unsigned long *flags);
 165 extern int transport_generic_map_mem_to_cmd(struct se_cmd *cmd, struct scatterlist *, u32,
 166                                 struct scatterlist *, u32);
 167 extern int transport_clear_lun_from_sessions(struct se_lun *);
 168 extern void transport_wait_for_tasks(struct se_cmd *);
 169 extern int transport_check_aborted_status(struct se_cmd *, int);
 170 extern int transport_send_check_condition_and_sense(struct se_cmd *, u8, int);
 171 extern void transport_send_task_abort(struct se_cmd *);
 172 extern void transport_release_cmd(struct se_cmd *);
 173 extern void transport_generic_free_cmd(struct se_cmd *, int);
 174 extern void transport_generic_wait_for_cmds(struct se_cmd *, int);
 175 extern void transport_do_task_sg_chain(struct se_cmd *);
 176 extern void transport_generic_process_write(struct se_cmd *);
 177 extern int transport_generic_new_cmd(struct se_cmd *);
 178 extern int transport_generic_do_tmr(struct se_cmd *);
 179 /* From target_core_alua.c */
 180 extern int core_alua_check_nonop_delay(struct se_cmd *);
 181 /* From target_core_cdb.c */
 182 extern int transport_emulate_control_cdb(struct se_task *);
 183 extern void target_get_task_cdb(struct se_task *task, unsigned char *cdb);
 184
 185 /*
 186  * Each se_transport_task_t can have N number of possible struct se_task's
 187  * for the storage transport(s) to possibly execute.
 188  * Used primarily for splitting up CDBs that exceed the physical storage
 189  * HBA's maximum sector count per task.
 190  */
 191 struct se_mem {
 192         struct page     *se_page;
 193         u32             se_len;
 194         u32             se_off;
 195         struct list_head se_list;
 196 } ____cacheline_aligned;
 197
 198 /*
 199  *      Each type of disk transport supported MUST have a template defined
 200  *      within its .h file.
 201  */
 202 struct se_subsystem_api {
 203         /*
 204          * The Name. :-)
 205          */
 206         char name[16];
 207         /*
 208          * Transport Type.
 209          */
 210         u8 transport_type;
 211
 212         unsigned int fua_write_emulated : 1;
 213         unsigned int write_cache_emulated : 1;
 214
 215         /*
 216          * struct module for struct se_hba references
 217          */
 218         struct module *owner;
 219         /*
 220          * Used for global se_subsystem_api list_head
 221          */
 222         struct list_head sub_api_list;
 223         /*
 224          * attach_hba():
 225          */
 226         int (*attach_hba)(struct se_hba *, u32);
 227         /*
 228          * detach_hba():
 229          */
 230         void (*detach_hba)(struct se_hba *);
 231         /*
 232          * pmode_hba(): Used for TCM/pSCSI subsystem plugin HBA ->
 233          *              Linux/SCSI struct Scsi_Host passthrough
 234         */
 235         int (*pmode_enable_hba)(struct se_hba *, unsigned long);
 236         /*
 237          * allocate_virtdevice():
 238          */
 239         void *(*allocate_virtdevice)(struct se_hba *, const char *);
 240         /*
 241          * create_virtdevice(): Only for Virtual HBAs
 242          */
 243         struct se_device *(*create_virtdevice)(struct se_hba *,
 244                                 struct se_subsystem_dev *, void *);
 245         /*
 246          * free_device():
 247          */
 248         void (*free_device)(void *);
 249
 250         /*
 251          * transport_complete():
 252          *
 253          * Use transport_generic_complete() for majority of DAS transport
 254          * drivers.  Provided out of convenience.
 255          */
 256         int (*transport_complete)(struct se_task *task);
 257         struct se_task *(*alloc_task)(unsigned char *cdb);
 258         /*
 259          * do_task():
 260          */
 261         int (*do_task)(struct se_task *);
 262         /*
 263          * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
 264          * UNMAP and WRITE_SAME_* w/ UNMAP=1 <-> Linux/Block Discard
 265          */
 266         int (*do_discard)(struct se_device *, sector_t, u32);
 267         /*
 268          * Used  by virtual subsystem plugins IBLOCK and FILEIO to emulate
 269          * SYNCHRONIZE_CACHE_* <-> Linux/Block blkdev_issue_flush()
 270          */
 271         void (*do_sync_cache)(struct se_task *);
 272         /*
 273          * free_task():
 274          */
 275         void (*free_task)(struct se_task *);
 276         /*
 277          * check_configfs_dev_params():
 278          */
 279         ssize_t (*check_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *);
 280         /*
 281          * set_configfs_dev_params():
 282          */
 283         ssize_t (*set_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *,
 284                                                 const char *, ssize_t);
 285         /*
 286          * show_configfs_dev_params():
 287          */
 288         ssize_t (*show_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *,
 289                                                 char *);
 290         /*
 291          * get_device_rev():
 292          */
 293         u32 (*get_device_rev)(struct se_device *);
 294         /*
 295          * get_device_type():
 296          */
 297         u32 (*get_device_type)(struct se_device *);
 298         /*
 299          * Get the sector_t from a subsystem backstore..
 300          */
 301         sector_t (*get_blocks)(struct se_device *);
 302         /*
 303          * get_sense_buffer():
 304          */
 305         unsigned char *(*get_sense_buffer)(struct se_task *);
 306 } ____cacheline_aligned;
 307
 308 #endif /* TARGET_CORE_TRANSPORT_H */