1 #ifndef DEF_RDMA_VT_H 2 #define DEF_RDMA_VT_H 3 4 /* 5 * Copyright(c) 2016 Intel Corporation. 6 * 7 * This file is provided under a dual BSD/GPLv2 license. When using or 8 * redistributing this file, you may do so under either license. 9 * 10 * GPL LICENSE SUMMARY 11 * 12 * This program is free software; you can redistribute it and/or modify 13 * it under the terms of version 2 of the GNU General Public License as 14 * published by the Free Software Foundation. 15 * 16 * This program is distributed in the hope that it will be useful, but 17 * WITHOUT ANY WARRANTY; without even the implied warranty of 18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19 * General Public License for more details. 20 * 21 * BSD LICENSE 22 * 23 * Redistribution and use in source and binary forms, with or without 24 * modification, are permitted provided that the following conditions 25 * are met: 26 * 27 * - Redistributions of source code must retain the above copyright 28 * notice, this list of conditions and the following disclaimer. 29 * - Redistributions in binary form must reproduce the above copyright 30 * notice, this list of conditions and the following disclaimer in 31 * the documentation and/or other materials provided with the 32 * distribution. 33 * - Neither the name of Intel Corporation nor the names of its 34 * contributors may be used to endorse or promote products derived 35 * from this software without specific prior written permission. 36 * 37 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 38 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 39 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 40 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 41 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 44 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 45 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 46 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 47 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 48 * 49 */ 50 51 /* 52 * Structure that low level drivers will populate in order to register with the 53 * rdmavt layer. 54 */ 55 56 #include <linux/spinlock.h> 57 #include <linux/list.h> 58 #include <linux/hash.h> 59 #include <rdma/ib_verbs.h> 60 #include <rdma/rdmavt_mr.h> 61 #include <rdma/rdmavt_qp.h> 62 63 #define RVT_MAX_PKEY_VALUES 16 64 65 struct rvt_ibport { 66 struct rvt_qp __rcu *qp[2]; 67 struct ib_mad_agent *send_agent; /* agent for SMI (traps) */ 68 struct rb_root mcast_tree; 69 spinlock_t lock; /* protect changes in this struct */ 70 71 /* non-zero when timer is set */ 72 unsigned long mkey_lease_timeout; 73 unsigned long trap_timeout; 74 __be64 gid_prefix; /* in network order */ 75 __be64 mkey; 76 u64 tid; 77 u32 port_cap_flags; 78 u32 pma_sample_start; 79 u32 pma_sample_interval; 80 __be16 pma_counter_select[5]; 81 u16 pma_tag; 82 u16 mkey_lease_period; 83 u16 sm_lid; 84 u8 sm_sl; 85 u8 mkeyprot; 86 u8 subnet_timeout; 87 u8 vl_high_limit; 88 89 /* 90 * Driver is expected to keep these up to date. These 91 * counters are informational only and not required to be 92 * completely accurate. 93 */ 94 u64 n_rc_resends; 95 u64 n_seq_naks; 96 u64 n_rdma_seq; 97 u64 n_rnr_naks; 98 u64 n_other_naks; 99 u64 n_loop_pkts; 100 u64 n_pkt_drops; 101 u64 n_vl15_dropped; 102 u64 n_rc_timeouts; 103 u64 n_dmawait; 104 u64 n_unaligned; 105 u64 n_rc_dupreq; 106 u64 n_rc_seqnak; 107 u16 pkey_violations; 108 u16 qkey_violations; 109 u16 mkey_violations; 110 111 /* Hot-path per CPU counters to avoid cacheline trading to update */ 112 u64 z_rc_acks; 113 u64 z_rc_qacks; 114 u64 z_rc_delayed_comp; 115 u64 __percpu *rc_acks; 116 u64 __percpu *rc_qacks; 117 u64 __percpu *rc_delayed_comp; 118 119 void *priv; /* driver private data */ 120 121 /* 122 * The pkey table is allocated and maintained by the driver. Drivers 123 * need to have access to this before registering with rdmav. However 124 * rdmavt will need access to it so drivers need to proviee this during 125 * the attach port API call. 126 */ 127 u16 *pkey_table; 128 129 struct rvt_ah *sm_ah; 130 }; 131 132 #define RVT_CQN_MAX 16 /* maximum length of cq name */ 133 134 /* 135 * Things that are driver specific, module parameters in hfi1 and qib 136 */ 137 struct rvt_driver_params { 138 struct ib_device_attr props; 139 140 /* 141 * Anything driver specific that is not covered by props 142 * For instance special module parameters. Goes here. 143 */ 144 unsigned int lkey_table_size; 145 unsigned int qp_table_size; 146 int qpn_start; 147 int qpn_inc; 148 int qpn_res_start; 149 int qpn_res_end; 150 int nports; 151 int npkeys; 152 char cq_name[RVT_CQN_MAX]; 153 int node; 154 int psn_mask; 155 int psn_shift; 156 int psn_modify_mask; 157 u32 core_cap_flags; 158 u32 max_mad_size; 159 u8 qos_shift; 160 u8 max_rdma_atomic; 161 u8 reserved_operations; 162 }; 163 164 /* Protection domain */ 165 struct rvt_pd { 166 struct ib_pd ibpd; 167 bool user; 168 }; 169 170 /* Address handle */ 171 struct rvt_ah { 172 struct ib_ah ibah; 173 struct rdma_ah_attr attr; 174 atomic_t refcount; 175 u8 vl; 176 u8 log_pmtu; 177 }; 178 179 struct rvt_dev_info; 180 struct rvt_swqe; 181 struct rvt_driver_provided { 182 /* 183 * Which functions are required depends on which verbs rdmavt is 184 * providing and which verbs the driver is overriding. See 185 * check_support() for details. 186 */ 187 188 /* hot path calldowns in a single cacheline */ 189 190 /* 191 * Give the driver a notice that there is send work to do. It is up to 192 * the driver to generally push the packets out, this just queues the 193 * work with the driver. There are two variants here. The no_lock 194 * version requires the s_lock not to be held. The other assumes the 195 * s_lock is held. 196 */ 197 void (*schedule_send)(struct rvt_qp *qp); 198 void (*schedule_send_no_lock)(struct rvt_qp *qp); 199 200 /* Driver specific work request checking */ 201 int (*check_send_wqe)(struct rvt_qp *qp, struct rvt_swqe *wqe); 202 203 /* 204 * Sometimes rdmavt needs to kick the driver's send progress. That is 205 * done by this call back. 206 */ 207 void (*do_send)(struct rvt_qp *qp); 208 209 /* Passed to ib core registration. Callback to create syfs files */ 210 int (*port_callback)(struct ib_device *, u8, struct kobject *); 211 212 /* 213 * Returns a string to represent the device for which is being 214 * registered. This is primarily used for error and debug messages on 215 * the console. 216 */ 217 const char * (*get_card_name)(struct rvt_dev_info *rdi); 218 219 /* 220 * Returns a pointer to the undelying hardware's PCI device. This is 221 * used to display information as to what hardware is being referenced 222 * in an output message 223 */ 224 struct pci_dev * (*get_pci_dev)(struct rvt_dev_info *rdi); 225 226 /* 227 * Allocate a private queue pair data structure for driver specific 228 * information which is opaque to rdmavt. Errors are returned via 229 * ERR_PTR(err). The driver is free to return NULL or a valid 230 * pointer. 231 */ 232 void * (*qp_priv_alloc)(struct rvt_dev_info *rdi, struct rvt_qp *qp); 233 234 /* 235 * Free the driver's private qp structure. 236 */ 237 void (*qp_priv_free)(struct rvt_dev_info *rdi, struct rvt_qp *qp); 238 239 /* 240 * Inform the driver the particular qp in quesiton has been reset so 241 * that it can clean up anything it needs to. 242 */ 243 void (*notify_qp_reset)(struct rvt_qp *qp); 244 245 /* 246 * Get a path mtu from the driver based on qp attributes. 247 */ 248 int (*get_pmtu_from_attr)(struct rvt_dev_info *rdi, struct rvt_qp *qp, 249 struct ib_qp_attr *attr); 250 251 /* 252 * Notify driver that it needs to flush any outstanding IO requests that 253 * are waiting on a qp. 254 */ 255 void (*flush_qp_waiters)(struct rvt_qp *qp); 256 257 /* 258 * Notify driver to stop its queue of sending packets. Nothing else 259 * should be posted to the queue pair after this has been called. 260 */ 261 void (*stop_send_queue)(struct rvt_qp *qp); 262 263 /* 264 * Have the drivr drain any in progress operations 265 */ 266 void (*quiesce_qp)(struct rvt_qp *qp); 267 268 /* 269 * Inform the driver a qp has went to error state. 270 */ 271 void (*notify_error_qp)(struct rvt_qp *qp); 272 273 /* 274 * Get an MTU for a qp. 275 */ 276 u32 (*mtu_from_qp)(struct rvt_dev_info *rdi, struct rvt_qp *qp, 277 u32 pmtu); 278 /* 279 * Convert an mtu to a path mtu 280 */ 281 int (*mtu_to_path_mtu)(u32 mtu); 282 283 /* 284 * Get the guid of a port in big endian byte order 285 */ 286 int (*get_guid_be)(struct rvt_dev_info *rdi, struct rvt_ibport *rvp, 287 int guid_index, __be64 *guid); 288 289 /* 290 * Query driver for the state of the port. 291 */ 292 int (*query_port_state)(struct rvt_dev_info *rdi, u8 port_num, 293 struct ib_port_attr *props); 294 295 /* 296 * Tell driver to shutdown a port 297 */ 298 int (*shut_down_port)(struct rvt_dev_info *rdi, u8 port_num); 299 300 /* Tell driver to send a trap for changed port capabilities */ 301 void (*cap_mask_chg)(struct rvt_dev_info *rdi, u8 port_num); 302 303 /* 304 * The following functions can be safely ignored completely. Any use of 305 * these is checked for NULL before blindly calling. Rdmavt should also 306 * be functional if drivers omit these. 307 */ 308 309 /* Called to inform the driver that all qps should now be freed. */ 310 unsigned (*free_all_qps)(struct rvt_dev_info *rdi); 311 312 /* Driver specific AH validation */ 313 int (*check_ah)(struct ib_device *, struct rdma_ah_attr *); 314 315 /* Inform the driver a new AH has been created */ 316 void (*notify_new_ah)(struct ib_device *, struct rdma_ah_attr *, 317 struct rvt_ah *); 318 319 /* Let the driver pick the next queue pair number*/ 320 int (*alloc_qpn)(struct rvt_dev_info *rdi, struct rvt_qpn_table *qpt, 321 enum ib_qp_type type, u8 port_num); 322 323 /* Determine if its safe or allowed to modify the qp */ 324 int (*check_modify_qp)(struct rvt_qp *qp, struct ib_qp_attr *attr, 325 int attr_mask, struct ib_udata *udata); 326 327 /* Driver specific QP modification/notification-of */ 328 void (*modify_qp)(struct rvt_qp *qp, struct ib_qp_attr *attr, 329 int attr_mask, struct ib_udata *udata); 330 331 /* Notify driver a mad agent has been created */ 332 void (*notify_create_mad_agent)(struct rvt_dev_info *rdi, int port_idx); 333 334 /* Notify driver a mad agent has been removed */ 335 void (*notify_free_mad_agent)(struct rvt_dev_info *rdi, int port_idx); 336 337 /* Notify driver to restart rc */ 338 void (*notify_restart_rc)(struct rvt_qp *qp, u32 psn, int wait); 339 }; 340 341 struct rvt_dev_info { 342 struct ib_device ibdev; /* Keep this first. Nothing above here */ 343 344 /* 345 * Prior to calling for registration the driver will be responsible for 346 * allocating space for this structure. 347 * 348 * The driver will also be responsible for filling in certain members of 349 * dparms.props. The driver needs to fill in dparms exactly as it would 350 * want values reported to a ULP. This will be returned to the caller 351 * in rdmavt's device. The driver should also therefore refrain from 352 * modifying this directly after registration with rdmavt. 353 */ 354 355 /* Driver specific properties */ 356 struct rvt_driver_params dparms; 357 358 /* post send table */ 359 const struct rvt_operation_params *post_parms; 360 361 /* Driver specific helper functions */ 362 struct rvt_driver_provided driver_f; 363 364 struct rvt_mregion __rcu *dma_mr; 365 struct rvt_lkey_table lkey_table; 366 367 /* Internal use */ 368 int n_pds_allocated; 369 spinlock_t n_pds_lock; /* Protect pd allocated count */ 370 371 int n_ahs_allocated; 372 spinlock_t n_ahs_lock; /* Protect ah allocated count */ 373 374 u32 n_srqs_allocated; 375 spinlock_t n_srqs_lock; /* Protect srqs allocated count */ 376 377 int flags; 378 struct rvt_ibport **ports; 379 380 /* QP */ 381 struct rvt_qp_ibdev *qp_dev; 382 u32 n_qps_allocated; /* number of QPs allocated for device */ 383 u32 n_rc_qps; /* number of RC QPs allocated for device */ 384 u32 busy_jiffies; /* timeout scaling based on RC QP count */ 385 spinlock_t n_qps_lock; /* protect qps, rc qps and busy jiffy counts */ 386 387 /* memory maps */ 388 struct list_head pending_mmaps; 389 spinlock_t mmap_offset_lock; /* protect mmap_offset */ 390 u32 mmap_offset; 391 spinlock_t pending_lock; /* protect pending mmap list */ 392 393 /* CQ */ 394 struct kthread_worker *worker; /* per device cq worker */ 395 u32 n_cqs_allocated; /* number of CQs allocated for device */ 396 spinlock_t n_cqs_lock; /* protect count of in use cqs */ 397 398 /* Multicast */ 399 u32 n_mcast_grps_allocated; /* number of mcast groups allocated */ 400 spinlock_t n_mcast_grps_lock; 401 402 }; 403 404 static inline struct rvt_pd *ibpd_to_rvtpd(struct ib_pd *ibpd) 405 { 406 return container_of(ibpd, struct rvt_pd, ibpd); 407 } 408 409 static inline struct rvt_ah *ibah_to_rvtah(struct ib_ah *ibah) 410 { 411 return container_of(ibah, struct rvt_ah, ibah); 412 } 413 414 static inline struct rvt_dev_info *ib_to_rvt(struct ib_device *ibdev) 415 { 416 return container_of(ibdev, struct rvt_dev_info, ibdev); 417 } 418 419 static inline struct rvt_srq *ibsrq_to_rvtsrq(struct ib_srq *ibsrq) 420 { 421 return container_of(ibsrq, struct rvt_srq, ibsrq); 422 } 423 424 static inline struct rvt_qp *ibqp_to_rvtqp(struct ib_qp *ibqp) 425 { 426 return container_of(ibqp, struct rvt_qp, ibqp); 427 } 428 429 static inline unsigned rvt_get_npkeys(struct rvt_dev_info *rdi) 430 { 431 /* 432 * All ports have same number of pkeys. 433 */ 434 return rdi->dparms.npkeys; 435 } 436 437 /* 438 * Return the max atomic suitable for determining 439 * the size of the ack ring buffer in a QP. 440 */ 441 static inline unsigned int rvt_max_atomic(struct rvt_dev_info *rdi) 442 { 443 return rdi->dparms.max_rdma_atomic + 1; 444 } 445 446 /* 447 * Return the indexed PKEY from the port PKEY table. 448 */ 449 static inline u16 rvt_get_pkey(struct rvt_dev_info *rdi, 450 int port_index, 451 unsigned index) 452 { 453 if (index >= rvt_get_npkeys(rdi)) 454 return 0; 455 else 456 return rdi->ports[port_index]->pkey_table[index]; 457 } 458 459 /** 460 * rvt_lookup_qpn - return the QP with the given QPN 461 * @ibp: the ibport 462 * @qpn: the QP number to look up 463 * 464 * The caller must hold the rcu_read_lock(), and keep the lock until 465 * the returned qp is no longer in use. 466 */ 467 /* TODO: Remove this and put in rdmavt/qp.h when no longer needed by drivers */ 468 static inline struct rvt_qp *rvt_lookup_qpn(struct rvt_dev_info *rdi, 469 struct rvt_ibport *rvp, 470 u32 qpn) __must_hold(RCU) 471 { 472 struct rvt_qp *qp = NULL; 473 474 if (unlikely(qpn <= 1)) { 475 qp = rcu_dereference(rvp->qp[qpn]); 476 } else { 477 u32 n = hash_32(qpn, rdi->qp_dev->qp_table_bits); 478 479 for (qp = rcu_dereference(rdi->qp_dev->qp_table[n]); qp; 480 qp = rcu_dereference(qp->next)) 481 if (qp->ibqp.qp_num == qpn) 482 break; 483 } 484 return qp; 485 } 486 487 /** 488 * rvt_mod_retry_timer - mod a retry timer 489 * @qp - the QP 490 * Modify a potentially already running retry timer 491 */ 492 static inline void rvt_mod_retry_timer(struct rvt_qp *qp) 493 { 494 struct ib_qp *ibqp = &qp->ibqp; 495 struct rvt_dev_info *rdi = ib_to_rvt(ibqp->device); 496 497 lockdep_assert_held(&qp->s_lock); 498 qp->s_flags |= RVT_S_TIMER; 499 /* 4.096 usec. * (1 << qp->timeout) */ 500 mod_timer(&qp->s_timer, jiffies + qp->timeout_jiffies + 501 rdi->busy_jiffies); 502 } 503 504 struct rvt_dev_info *rvt_alloc_device(size_t size, int nports); 505 void rvt_dealloc_device(struct rvt_dev_info *rdi); 506 int rvt_register_device(struct rvt_dev_info *rvd); 507 void rvt_unregister_device(struct rvt_dev_info *rvd); 508 int rvt_check_ah(struct ib_device *ibdev, struct rdma_ah_attr *ah_attr); 509 int rvt_init_port(struct rvt_dev_info *rdi, struct rvt_ibport *port, 510 int port_index, u16 *pkey_table); 511 int rvt_fast_reg_mr(struct rvt_qp *qp, struct ib_mr *ibmr, u32 key, 512 int access); 513 int rvt_invalidate_rkey(struct rvt_qp *qp, u32 rkey); 514 int rvt_rkey_ok(struct rvt_qp *qp, struct rvt_sge *sge, 515 u32 len, u64 vaddr, u32 rkey, int acc); 516 int rvt_lkey_ok(struct rvt_lkey_table *rkt, struct rvt_pd *pd, 517 struct rvt_sge *isge, struct ib_sge *sge, int acc); 518 struct rvt_mcast *rvt_mcast_find(struct rvt_ibport *ibp, union ib_gid *mgid, 519 u16 lid); 520 521 #endif /* DEF_RDMA_VT_H */ 522