1 #ifndef DEF_RDMA_VT_H 2 #define DEF_RDMA_VT_H 3 4 /* 5 * Copyright(c) 2016 - 2018 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/ib_mad.h> 61 #include <rdma/rdmavt_mr.h> 62 #include <rdma/rdmavt_qp.h> 63 64 #define RVT_MAX_PKEY_VALUES 16 65 66 #define RVT_MAX_TRAP_LEN 100 /* Limit pending trap list */ 67 #define RVT_MAX_TRAP_LISTS 5 /*((IB_NOTICE_TYPE_INFO & 0x0F) + 1)*/ 68 #define RVT_TRAP_TIMEOUT 4096 /* 4.096 usec */ 69 70 struct trap_list { 71 u32 list_len; 72 struct list_head list; 73 }; 74 75 struct rvt_ibport { 76 struct rvt_qp __rcu *qp[2]; 77 struct ib_mad_agent *send_agent; /* agent for SMI (traps) */ 78 struct rb_root mcast_tree; 79 spinlock_t lock; /* protect changes in this struct */ 80 81 /* non-zero when timer is set */ 82 unsigned long mkey_lease_timeout; 83 unsigned long trap_timeout; 84 __be64 gid_prefix; /* in network order */ 85 __be64 mkey; 86 u64 tid; 87 u32 port_cap_flags; 88 u16 port_cap3_flags; 89 u32 pma_sample_start; 90 u32 pma_sample_interval; 91 __be16 pma_counter_select[5]; 92 u16 pma_tag; 93 u16 mkey_lease_period; 94 u32 sm_lid; 95 u8 sm_sl; 96 u8 mkeyprot; 97 u8 subnet_timeout; 98 u8 vl_high_limit; 99 100 /* 101 * Driver is expected to keep these up to date. These 102 * counters are informational only and not required to be 103 * completely accurate. 104 */ 105 u64 n_rc_resends; 106 u64 n_seq_naks; 107 u64 n_rdma_seq; 108 u64 n_rnr_naks; 109 u64 n_other_naks; 110 u64 n_loop_pkts; 111 u64 n_pkt_drops; 112 u64 n_vl15_dropped; 113 u64 n_rc_timeouts; 114 u64 n_dmawait; 115 u64 n_unaligned; 116 u64 n_rc_dupreq; 117 u64 n_rc_seqnak; 118 u16 pkey_violations; 119 u16 qkey_violations; 120 u16 mkey_violations; 121 122 /* Hot-path per CPU counters to avoid cacheline trading to update */ 123 u64 z_rc_acks; 124 u64 z_rc_qacks; 125 u64 z_rc_delayed_comp; 126 u64 __percpu *rc_acks; 127 u64 __percpu *rc_qacks; 128 u64 __percpu *rc_delayed_comp; 129 130 void *priv; /* driver private data */ 131 132 /* 133 * The pkey table is allocated and maintained by the driver. Drivers 134 * need to have access to this before registering with rdmav. However 135 * rdmavt will need access to it so drivers need to proviee this during 136 * the attach port API call. 137 */ 138 u16 *pkey_table; 139 140 struct rvt_ah *sm_ah; 141 142 /* 143 * Keep a list of traps that have not been repressed. They will be 144 * resent based on trap_timer. 145 */ 146 struct trap_list trap_lists[RVT_MAX_TRAP_LISTS]; 147 struct timer_list trap_timer; 148 }; 149 150 #define RVT_CQN_MAX 16 /* maximum length of cq name */ 151 152 #define RVT_SGE_COPY_MEMCPY 0 153 #define RVT_SGE_COPY_CACHELESS 1 154 #define RVT_SGE_COPY_ADAPTIVE 2 155 156 /* 157 * Things that are driver specific, module parameters in hfi1 and qib 158 */ 159 struct rvt_driver_params { 160 struct ib_device_attr props; 161 162 /* 163 * Anything driver specific that is not covered by props 164 * For instance special module parameters. Goes here. 165 */ 166 unsigned int lkey_table_size; 167 unsigned int qp_table_size; 168 unsigned int sge_copy_mode; 169 unsigned int wss_threshold; 170 unsigned int wss_clean_period; 171 int qpn_start; 172 int qpn_inc; 173 int qpn_res_start; 174 int qpn_res_end; 175 int nports; 176 int npkeys; 177 int node; 178 int psn_mask; 179 int psn_shift; 180 int psn_modify_mask; 181 u32 core_cap_flags; 182 u32 max_mad_size; 183 u8 qos_shift; 184 u8 max_rdma_atomic; 185 u8 reserved_operations; 186 }; 187 188 /* Protection domain */ 189 struct rvt_pd { 190 struct ib_pd ibpd; 191 bool user; 192 }; 193 194 /* Address handle */ 195 struct rvt_ah { 196 struct ib_ah ibah; 197 struct rdma_ah_attr attr; 198 atomic_t refcount; 199 u8 vl; 200 u8 log_pmtu; 201 }; 202 203 /* memory working set size */ 204 struct rvt_wss { 205 unsigned long *entries; 206 atomic_t total_count; 207 atomic_t clean_counter; 208 atomic_t clean_entry; 209 210 int threshold; 211 int num_entries; 212 long pages_mask; 213 unsigned int clean_period; 214 }; 215 216 struct rvt_dev_info; 217 struct rvt_swqe; 218 struct rvt_driver_provided { 219 /* 220 * Which functions are required depends on which verbs rdmavt is 221 * providing and which verbs the driver is overriding. See 222 * check_support() for details. 223 */ 224 225 /* hot path calldowns in a single cacheline */ 226 227 /* 228 * Give the driver a notice that there is send work to do. It is up to 229 * the driver to generally push the packets out, this just queues the 230 * work with the driver. There are two variants here. The no_lock 231 * version requires the s_lock not to be held. The other assumes the 232 * s_lock is held. 233 */ 234 bool (*schedule_send)(struct rvt_qp *qp); 235 bool (*schedule_send_no_lock)(struct rvt_qp *qp); 236 237 /* 238 * Driver specific work request setup and checking. 239 * This function is allowed to perform any setup, checks, or 240 * adjustments required to the SWQE in order to be usable by 241 * underlying protocols. This includes private data structure 242 * allocations. 243 */ 244 int (*setup_wqe)(struct rvt_qp *qp, struct rvt_swqe *wqe, 245 bool *call_send); 246 247 /* 248 * Sometimes rdmavt needs to kick the driver's send progress. That is 249 * done by this call back. 250 */ 251 void (*do_send)(struct rvt_qp *qp); 252 253 /* 254 * Returns a pointer to the undelying hardware's PCI device. This is 255 * used to display information as to what hardware is being referenced 256 * in an output message 257 */ 258 struct pci_dev * (*get_pci_dev)(struct rvt_dev_info *rdi); 259 260 /* 261 * Allocate a private queue pair data structure for driver specific 262 * information which is opaque to rdmavt. Errors are returned via 263 * ERR_PTR(err). The driver is free to return NULL or a valid 264 * pointer. 265 */ 266 void * (*qp_priv_alloc)(struct rvt_dev_info *rdi, struct rvt_qp *qp); 267 268 /* 269 * Init a struture allocated with qp_priv_alloc(). This should be 270 * called after all qp fields have been initialized in rdmavt. 271 */ 272 int (*qp_priv_init)(struct rvt_dev_info *rdi, struct rvt_qp *qp, 273 struct ib_qp_init_attr *init_attr); 274 275 /* 276 * Free the driver's private qp structure. 277 */ 278 void (*qp_priv_free)(struct rvt_dev_info *rdi, struct rvt_qp *qp); 279 280 /* 281 * Inform the driver the particular qp in quesiton has been reset so 282 * that it can clean up anything it needs to. 283 */ 284 void (*notify_qp_reset)(struct rvt_qp *qp); 285 286 /* 287 * Get a path mtu from the driver based on qp attributes. 288 */ 289 int (*get_pmtu_from_attr)(struct rvt_dev_info *rdi, struct rvt_qp *qp, 290 struct ib_qp_attr *attr); 291 292 /* 293 * Notify driver that it needs to flush any outstanding IO requests that 294 * are waiting on a qp. 295 */ 296 void (*flush_qp_waiters)(struct rvt_qp *qp); 297 298 /* 299 * Notify driver to stop its queue of sending packets. Nothing else 300 * should be posted to the queue pair after this has been called. 301 */ 302 void (*stop_send_queue)(struct rvt_qp *qp); 303 304 /* 305 * Have the drivr drain any in progress operations 306 */ 307 void (*quiesce_qp)(struct rvt_qp *qp); 308 309 /* 310 * Inform the driver a qp has went to error state. 311 */ 312 void (*notify_error_qp)(struct rvt_qp *qp); 313 314 /* 315 * Get an MTU for a qp. 316 */ 317 u32 (*mtu_from_qp)(struct rvt_dev_info *rdi, struct rvt_qp *qp, 318 u32 pmtu); 319 /* 320 * Convert an mtu to a path mtu 321 */ 322 int (*mtu_to_path_mtu)(u32 mtu); 323 324 /* 325 * Get the guid of a port in big endian byte order 326 */ 327 int (*get_guid_be)(struct rvt_dev_info *rdi, struct rvt_ibport *rvp, 328 int guid_index, __be64 *guid); 329 330 /* 331 * Query driver for the state of the port. 332 */ 333 int (*query_port_state)(struct rvt_dev_info *rdi, u8 port_num, 334 struct ib_port_attr *props); 335 336 /* 337 * Tell driver to shutdown a port 338 */ 339 int (*shut_down_port)(struct rvt_dev_info *rdi, u8 port_num); 340 341 /* Tell driver to send a trap for changed port capabilities */ 342 void (*cap_mask_chg)(struct rvt_dev_info *rdi, u8 port_num); 343 344 /* 345 * The following functions can be safely ignored completely. Any use of 346 * these is checked for NULL before blindly calling. Rdmavt should also 347 * be functional if drivers omit these. 348 */ 349 350 /* Called to inform the driver that all qps should now be freed. */ 351 unsigned (*free_all_qps)(struct rvt_dev_info *rdi); 352 353 /* Driver specific AH validation */ 354 int (*check_ah)(struct ib_device *, struct rdma_ah_attr *); 355 356 /* Inform the driver a new AH has been created */ 357 void (*notify_new_ah)(struct ib_device *, struct rdma_ah_attr *, 358 struct rvt_ah *); 359 360 /* Let the driver pick the next queue pair number*/ 361 int (*alloc_qpn)(struct rvt_dev_info *rdi, struct rvt_qpn_table *qpt, 362 enum ib_qp_type type, u8 port_num); 363 364 /* Determine if its safe or allowed to modify the qp */ 365 int (*check_modify_qp)(struct rvt_qp *qp, struct ib_qp_attr *attr, 366 int attr_mask, struct ib_udata *udata); 367 368 /* Driver specific QP modification/notification-of */ 369 void (*modify_qp)(struct rvt_qp *qp, struct ib_qp_attr *attr, 370 int attr_mask, struct ib_udata *udata); 371 372 /* Notify driver a mad agent has been created */ 373 void (*notify_create_mad_agent)(struct rvt_dev_info *rdi, int port_idx); 374 375 /* Notify driver a mad agent has been removed */ 376 void (*notify_free_mad_agent)(struct rvt_dev_info *rdi, int port_idx); 377 378 /* Notify driver to restart rc */ 379 void (*notify_restart_rc)(struct rvt_qp *qp, u32 psn, int wait); 380 381 /* Get and return CPU to pin CQ processing thread */ 382 int (*comp_vect_cpu_lookup)(struct rvt_dev_info *rdi, int comp_vect); 383 }; 384 385 struct rvt_dev_info { 386 struct ib_device ibdev; /* Keep this first. Nothing above here */ 387 388 /* 389 * Prior to calling for registration the driver will be responsible for 390 * allocating space for this structure. 391 * 392 * The driver will also be responsible for filling in certain members of 393 * dparms.props. The driver needs to fill in dparms exactly as it would 394 * want values reported to a ULP. This will be returned to the caller 395 * in rdmavt's device. The driver should also therefore refrain from 396 * modifying this directly after registration with rdmavt. 397 */ 398 399 /* Driver specific properties */ 400 struct rvt_driver_params dparms; 401 402 /* post send table */ 403 const struct rvt_operation_params *post_parms; 404 405 /* opcode translation table */ 406 const enum ib_wc_opcode *wc_opcode; 407 408 /* Driver specific helper functions */ 409 struct rvt_driver_provided driver_f; 410 411 struct rvt_mregion __rcu *dma_mr; 412 struct rvt_lkey_table lkey_table; 413 414 /* Internal use */ 415 int n_pds_allocated; 416 spinlock_t n_pds_lock; /* Protect pd allocated count */ 417 418 int n_ahs_allocated; 419 spinlock_t n_ahs_lock; /* Protect ah allocated count */ 420 421 u32 n_srqs_allocated; 422 spinlock_t n_srqs_lock; /* Protect srqs allocated count */ 423 424 int flags; 425 struct rvt_ibport **ports; 426 427 /* QP */ 428 struct rvt_qp_ibdev *qp_dev; 429 u32 n_qps_allocated; /* number of QPs allocated for device */ 430 u32 n_rc_qps; /* number of RC QPs allocated for device */ 431 u32 busy_jiffies; /* timeout scaling based on RC QP count */ 432 spinlock_t n_qps_lock; /* protect qps, rc qps and busy jiffy counts */ 433 434 /* memory maps */ 435 struct list_head pending_mmaps; 436 spinlock_t mmap_offset_lock; /* protect mmap_offset */ 437 u32 mmap_offset; 438 spinlock_t pending_lock; /* protect pending mmap list */ 439 440 /* CQ */ 441 u32 n_cqs_allocated; /* number of CQs allocated for device */ 442 spinlock_t n_cqs_lock; /* protect count of in use cqs */ 443 444 /* Multicast */ 445 u32 n_mcast_grps_allocated; /* number of mcast groups allocated */ 446 spinlock_t n_mcast_grps_lock; 447 448 /* Memory Working Set Size */ 449 struct rvt_wss *wss; 450 }; 451 452 /** 453 * rvt_set_ibdev_name - Craft an IB device name from client info 454 * @rdi: pointer to the client rvt_dev_info structure 455 * @name: client specific name 456 * @unit: client specific unit number. 457 */ 458 static inline void rvt_set_ibdev_name(struct rvt_dev_info *rdi, 459 const char *fmt, const char *name, 460 const int unit) 461 { 462 /* 463 * FIXME: rvt and its users want to touch the ibdev before 464 * registration and have things like the name work. We don't have the 465 * infrastructure in the core to support this directly today, hack it 466 * to work by setting the name manually here. 467 */ 468 dev_set_name(&rdi->ibdev.dev, fmt, name, unit); 469 strlcpy(rdi->ibdev.name, dev_name(&rdi->ibdev.dev), IB_DEVICE_NAME_MAX); 470 } 471 472 /** 473 * rvt_get_ibdev_name - return the IB name 474 * @rdi: rdmavt device 475 * 476 * Return the registered name of the device. 477 */ 478 static inline const char *rvt_get_ibdev_name(const struct rvt_dev_info *rdi) 479 { 480 return dev_name(&rdi->ibdev.dev); 481 } 482 483 static inline struct rvt_pd *ibpd_to_rvtpd(struct ib_pd *ibpd) 484 { 485 return container_of(ibpd, struct rvt_pd, ibpd); 486 } 487 488 static inline struct rvt_ah *ibah_to_rvtah(struct ib_ah *ibah) 489 { 490 return container_of(ibah, struct rvt_ah, ibah); 491 } 492 493 static inline struct rvt_dev_info *ib_to_rvt(struct ib_device *ibdev) 494 { 495 return container_of(ibdev, struct rvt_dev_info, ibdev); 496 } 497 498 static inline struct rvt_srq *ibsrq_to_rvtsrq(struct ib_srq *ibsrq) 499 { 500 return container_of(ibsrq, struct rvt_srq, ibsrq); 501 } 502 503 static inline struct rvt_qp *ibqp_to_rvtqp(struct ib_qp *ibqp) 504 { 505 return container_of(ibqp, struct rvt_qp, ibqp); 506 } 507 508 static inline unsigned rvt_get_npkeys(struct rvt_dev_info *rdi) 509 { 510 /* 511 * All ports have same number of pkeys. 512 */ 513 return rdi->dparms.npkeys; 514 } 515 516 /* 517 * Return the max atomic suitable for determining 518 * the size of the ack ring buffer in a QP. 519 */ 520 static inline unsigned int rvt_max_atomic(struct rvt_dev_info *rdi) 521 { 522 return rdi->dparms.max_rdma_atomic + 1; 523 } 524 525 /* 526 * Return the indexed PKEY from the port PKEY table. 527 */ 528 static inline u16 rvt_get_pkey(struct rvt_dev_info *rdi, 529 int port_index, 530 unsigned index) 531 { 532 if (index >= rvt_get_npkeys(rdi)) 533 return 0; 534 else 535 return rdi->ports[port_index]->pkey_table[index]; 536 } 537 538 /** 539 * rvt_lookup_qpn - return the QP with the given QPN 540 * @ibp: the ibport 541 * @qpn: the QP number to look up 542 * 543 * The caller must hold the rcu_read_lock(), and keep the lock until 544 * the returned qp is no longer in use. 545 */ 546 /* TODO: Remove this and put in rdmavt/qp.h when no longer needed by drivers */ 547 static inline struct rvt_qp *rvt_lookup_qpn(struct rvt_dev_info *rdi, 548 struct rvt_ibport *rvp, 549 u32 qpn) __must_hold(RCU) 550 { 551 struct rvt_qp *qp = NULL; 552 553 if (unlikely(qpn <= 1)) { 554 qp = rcu_dereference(rvp->qp[qpn]); 555 } else { 556 u32 n = hash_32(qpn, rdi->qp_dev->qp_table_bits); 557 558 for (qp = rcu_dereference(rdi->qp_dev->qp_table[n]); qp; 559 qp = rcu_dereference(qp->next)) 560 if (qp->ibqp.qp_num == qpn) 561 break; 562 } 563 return qp; 564 } 565 566 /** 567 * rvt_mod_retry_timer - mod a retry timer 568 * @qp - the QP 569 * Modify a potentially already running retry timer 570 */ 571 static inline void rvt_mod_retry_timer(struct rvt_qp *qp) 572 { 573 struct ib_qp *ibqp = &qp->ibqp; 574 struct rvt_dev_info *rdi = ib_to_rvt(ibqp->device); 575 576 lockdep_assert_held(&qp->s_lock); 577 qp->s_flags |= RVT_S_TIMER; 578 /* 4.096 usec. * (1 << qp->timeout) */ 579 mod_timer(&qp->s_timer, jiffies + qp->timeout_jiffies + 580 rdi->busy_jiffies); 581 } 582 583 struct rvt_dev_info *rvt_alloc_device(size_t size, int nports); 584 void rvt_dealloc_device(struct rvt_dev_info *rdi); 585 int rvt_register_device(struct rvt_dev_info *rvd, u32 driver_id); 586 void rvt_unregister_device(struct rvt_dev_info *rvd); 587 int rvt_check_ah(struct ib_device *ibdev, struct rdma_ah_attr *ah_attr); 588 int rvt_init_port(struct rvt_dev_info *rdi, struct rvt_ibport *port, 589 int port_index, u16 *pkey_table); 590 int rvt_fast_reg_mr(struct rvt_qp *qp, struct ib_mr *ibmr, u32 key, 591 int access); 592 int rvt_invalidate_rkey(struct rvt_qp *qp, u32 rkey); 593 int rvt_rkey_ok(struct rvt_qp *qp, struct rvt_sge *sge, 594 u32 len, u64 vaddr, u32 rkey, int acc); 595 int rvt_lkey_ok(struct rvt_lkey_table *rkt, struct rvt_pd *pd, 596 struct rvt_sge *isge, struct rvt_sge *last_sge, 597 struct ib_sge *sge, int acc); 598 struct rvt_mcast *rvt_mcast_find(struct rvt_ibport *ibp, union ib_gid *mgid, 599 u16 lid); 600 601 #endif /* DEF_RDMA_VT_H */ 602