1 /* 2 * Copyright (c) 2005 Cisco Systems. All rights reserved. 3 * 4 * This software is available to you under a choice of one of two 5 * licenses. You may choose to be licensed under the terms of the GNU 6 * General Public License (GPL) Version 2, available from the file 7 * COPYING in the main directory of this source tree, or the 8 * OpenIB.org BSD license below: 9 * 10 * Redistribution and use in source and binary forms, with or 11 * without modification, are permitted provided that the following 12 * conditions are met: 13 * 14 * - Redistributions of source code must retain the above 15 * copyright notice, this list of conditions and the following 16 * disclaimer. 17 * 18 * - Redistributions in binary form must reproduce the above 19 * copyright notice, this list of conditions and the following 20 * disclaimer in the documentation and/or other materials 21 * provided with the distribution. 22 * 23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 30 * SOFTWARE. 31 */ 32 33 #ifndef IB_SRP_H 34 #define IB_SRP_H 35 36 #include <linux/types.h> 37 #include <linux/list.h> 38 #include <linux/mutex.h> 39 #include <linux/scatterlist.h> 40 41 #include <scsi/scsi_host.h> 42 #include <scsi/scsi_cmnd.h> 43 44 #include <rdma/ib_verbs.h> 45 #include <rdma/ib_sa.h> 46 #include <rdma/ib_cm.h> 47 #include <rdma/rdma_cm.h> 48 49 enum { 50 SRP_PATH_REC_TIMEOUT_MS = 1000, 51 SRP_ABORT_TIMEOUT_MS = 5000, 52 53 SRP_PORT_REDIRECT = 1, 54 SRP_DLID_REDIRECT = 2, 55 SRP_STALE_CONN = 3, 56 57 SRP_DEF_SG_TABLESIZE = 12, 58 59 SRP_DEFAULT_QUEUE_SIZE = 1 << 6, 60 SRP_RSP_SQ_SIZE = 1, 61 SRP_TSK_MGMT_SQ_SIZE = 1, 62 SRP_DEFAULT_CMD_SQ_SIZE = SRP_DEFAULT_QUEUE_SIZE - SRP_RSP_SQ_SIZE - 63 SRP_TSK_MGMT_SQ_SIZE, 64 65 SRP_TAG_NO_REQ = ~0U, 66 SRP_TAG_TSK_MGMT = 1U << 31, 67 68 SRP_MAX_PAGES_PER_MR = 512, 69 70 SRP_MAX_ADD_CDB_LEN = 16, 71 72 SRP_MAX_IMM_SGE = 2, 73 SRP_MAX_SGE = SRP_MAX_IMM_SGE + 1, 74 /* 75 * Choose the immediate data offset such that a 32 byte CDB still fits. 76 */ 77 SRP_IMM_DATA_OFFSET = sizeof(struct srp_cmd) + 78 SRP_MAX_ADD_CDB_LEN + 79 sizeof(struct srp_imm_buf), 80 }; 81 82 enum srp_target_state { 83 SRP_TARGET_SCANNING, 84 SRP_TARGET_LIVE, 85 SRP_TARGET_REMOVED, 86 }; 87 88 enum srp_iu_type { 89 SRP_IU_CMD, 90 SRP_IU_TSK_MGMT, 91 SRP_IU_RSP, 92 }; 93 94 /* 95 * RDMA adapter in the initiator system. 96 * 97 * @dev_list: List of RDMA ports associated with this RDMA adapter (srp_host). 98 * @mr_page_mask: HCA memory registration page mask. 99 * @mr_page_size: HCA memory registration page size. 100 * @mr_max_size: Maximum size in bytes of a single FR registration request. 101 */ 102 struct srp_device { 103 struct list_head dev_list; 104 struct ib_device *dev; 105 struct ib_pd *pd; 106 u32 global_rkey; 107 u64 mr_page_mask; 108 int mr_page_size; 109 int mr_max_size; 110 int max_pages_per_mr; 111 bool has_fr; 112 bool use_fast_reg; 113 }; 114 115 /* 116 * One port of an RDMA adapter in the initiator system. 117 * 118 * @target_list: List of connected target ports (struct srp_target_port). 119 * @target_lock: Protects @target_list. 120 */ 121 struct srp_host { 122 struct srp_device *srp_dev; 123 u32 port; 124 struct device dev; 125 struct list_head target_list; 126 spinlock_t target_lock; 127 struct list_head list; 128 struct mutex add_target_mutex; 129 }; 130 131 struct srp_request { 132 struct scsi_cmnd *scmnd; 133 struct srp_iu *cmd; 134 struct srp_fr_desc **fr_list; 135 struct srp_direct_buf *indirect_desc; 136 dma_addr_t indirect_dma_addr; 137 short nmdesc; 138 struct ib_cqe reg_cqe; 139 }; 140 141 /** 142 * struct srp_rdma_ch 143 * @comp_vector: Completion vector used by this RDMA channel. 144 * @max_it_iu_len: Maximum initiator-to-target information unit length. 145 * @max_ti_iu_len: Maximum target-to-initiator information unit length. 146 */ 147 struct srp_rdma_ch { 148 /* These are RW in the hot path, and commonly used together */ 149 struct list_head free_tx; 150 spinlock_t lock; 151 s32 req_lim; 152 153 /* These are read-only in the hot path */ 154 struct srp_target_port *target ____cacheline_aligned_in_smp; 155 struct ib_cq *send_cq; 156 struct ib_cq *recv_cq; 157 struct ib_qp *qp; 158 struct srp_fr_pool *fr_pool; 159 uint32_t max_it_iu_len; 160 uint32_t max_ti_iu_len; 161 u8 max_imm_sge; 162 bool use_imm_data; 163 164 /* Everything above this point is used in the hot path of 165 * command processing. Try to keep them packed into cachelines. 166 */ 167 168 struct completion done; 169 int status; 170 171 union { 172 struct ib_cm { 173 struct sa_path_rec path; 174 struct ib_sa_query *path_query; 175 int path_query_id; 176 struct ib_cm_id *cm_id; 177 } ib_cm; 178 struct rdma_cm { 179 struct rdma_cm_id *cm_id; 180 } rdma_cm; 181 }; 182 183 struct srp_iu **tx_ring; 184 struct srp_iu **rx_ring; 185 int comp_vector; 186 187 u64 tsk_mgmt_tag; 188 struct completion tsk_mgmt_done; 189 u8 tsk_mgmt_status; 190 bool connected; 191 }; 192 193 /** 194 * struct srp_target_port - RDMA port in the SRP target system 195 * @comp_vector: Completion vector used by the first RDMA channel created for 196 * this target port. 197 */ 198 struct srp_target_port { 199 /* read and written in the hot path */ 200 spinlock_t lock; 201 202 /* read only in the hot path */ 203 u32 global_rkey; 204 struct srp_rdma_ch *ch; 205 struct net *net; 206 u32 ch_count; 207 u32 lkey; 208 enum srp_target_state state; 209 uint32_t max_it_iu_size; 210 unsigned int cmd_sg_cnt; 211 unsigned int indirect_size; 212 bool allow_ext_sg; 213 214 /* other member variables */ 215 union ib_gid sgid; 216 __be64 id_ext; 217 __be64 ioc_guid; 218 __be64 initiator_ext; 219 u16 io_class; 220 struct srp_host *srp_host; 221 struct Scsi_Host *scsi_host; 222 struct srp_rport *rport; 223 char target_name[32]; 224 unsigned int scsi_id; 225 unsigned int sg_tablesize; 226 unsigned int target_can_queue; 227 int mr_pool_size; 228 int mr_per_cmd; 229 int queue_size; 230 int comp_vector; 231 int tl_retry_count; 232 233 bool using_rdma_cm; 234 235 union { 236 struct { 237 __be64 service_id; 238 union ib_gid orig_dgid; 239 __be16 pkey; 240 } ib_cm; 241 struct { 242 union { 243 struct sockaddr_in ip4; 244 struct sockaddr_in6 ip6; 245 struct sockaddr sa; 246 struct sockaddr_storage ss; 247 } src; 248 union { 249 struct sockaddr_in ip4; 250 struct sockaddr_in6 ip6; 251 struct sockaddr sa; 252 struct sockaddr_storage ss; 253 } dst; 254 bool src_specified; 255 } rdma_cm; 256 }; 257 258 u32 rq_tmo_jiffies; 259 260 int zero_req_lim; 261 262 struct work_struct tl_err_work; 263 struct work_struct remove_work; 264 265 struct list_head list; 266 bool qp_in_error; 267 }; 268 269 struct srp_iu { 270 struct list_head list; 271 u64 dma; 272 void *buf; 273 size_t size; 274 enum dma_data_direction direction; 275 u32 num_sge; 276 struct ib_sge sge[SRP_MAX_SGE]; 277 struct ib_cqe cqe; 278 }; 279 280 /** 281 * struct srp_fr_desc - fast registration work request arguments 282 * @entry: Entry in srp_fr_pool.free_list. 283 * @mr: Memory region. 284 * @frpl: Fast registration page list. 285 */ 286 struct srp_fr_desc { 287 struct list_head entry; 288 struct ib_mr *mr; 289 }; 290 291 /** 292 * struct srp_fr_pool - pool of fast registration descriptors 293 * 294 * An entry is available for allocation if and only if it occurs in @free_list. 295 * 296 * @size: Number of descriptors in this pool. 297 * @max_page_list_len: Maximum fast registration work request page list length. 298 * @lock: Protects free_list. 299 * @free_list: List of free descriptors. 300 * @desc: Fast registration descriptor pool. 301 */ 302 struct srp_fr_pool { 303 int size; 304 int max_page_list_len; 305 spinlock_t lock; 306 struct list_head free_list; 307 struct srp_fr_desc desc[]; 308 }; 309 310 /** 311 * struct srp_map_state - per-request DMA memory mapping state 312 * @desc: Pointer to the element of the SRP buffer descriptor array 313 * that is being filled in. 314 * @pages: Array with DMA addresses of pages being considered for 315 * memory registration. 316 * @base_dma_addr: DMA address of the first page that has not yet been mapped. 317 * @dma_len: Number of bytes that will be registered with the next FR 318 * memory registration call. 319 * @total_len: Total number of bytes in the sg-list being mapped. 320 * @npages: Number of page addresses in the pages[] array. 321 * @nmdesc: Number of FR memory descriptors used for mapping. 322 * @ndesc: Number of SRP buffer descriptors that have been filled in. 323 */ 324 struct srp_map_state { 325 union { 326 struct { 327 struct srp_fr_desc **next; 328 struct srp_fr_desc **end; 329 } fr; 330 struct { 331 void **next; 332 void **end; 333 } gen; 334 }; 335 struct srp_direct_buf *desc; 336 union { 337 u64 *pages; 338 struct scatterlist *sg; 339 }; 340 dma_addr_t base_dma_addr; 341 u32 dma_len; 342 u32 total_len; 343 unsigned int npages; 344 unsigned int nmdesc; 345 unsigned int ndesc; 346 }; 347 348 #endif /* IB_SRP_H */ 349