drivers/infiniband/hw/hfi1/verbs.h

   1 /*
   2  * Copyright(c) 2015 - 2017 Intel Corporation.
   3  *
   4  * This file is provided under a dual BSD/GPLv2 license.  When using or
   5  * redistributing this file, you may do so under either license.
   6  *
   7  * GPL LICENSE SUMMARY
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * BSD LICENSE
  19  *
  20  * Redistribution and use in source and binary forms, with or without
  21  * modification, are permitted provided that the following conditions
  22  * are met:
  23  *
  24  *  - Redistributions of source code must retain the above copyright
  25  *    notice, this list of conditions and the following disclaimer.
  26  *  - Redistributions in binary form must reproduce the above copyright
  27  *    notice, this list of conditions and the following disclaimer in
  28  *    the documentation and/or other materials provided with the
  29  *    distribution.
  30  *  - Neither the name of Intel Corporation nor the names of its
  31  *    contributors may be used to endorse or promote products derived
  32  *    from this software without specific prior written permission.
  33  *
  34  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  35  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  36  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  37  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  38  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  39  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  40  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  41  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  42  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  43  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  44  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  45  *
  46  */
  47
  48 #ifndef HFI1_VERBS_H
  49 #define HFI1_VERBS_H
  50
  51 #include <linux/types.h>
  52 #include <linux/seqlock.h>
  53 #include <linux/kernel.h>
  54 #include <linux/interrupt.h>
  55 #include <linux/kref.h>
  56 #include <linux/workqueue.h>
  57 #include <linux/kthread.h>
  58 #include <linux/completion.h>
  59 #include <linux/slab.h>
  60 #include <rdma/ib_pack.h>
  61 #include <rdma/ib_user_verbs.h>
  62 #include <rdma/ib_mad.h>
  63 #include <rdma/ib_hdrs.h>
  64 #include <rdma/rdma_vt.h>
  65 #include <rdma/rdmavt_qp.h>
  66 #include <rdma/rdmavt_cq.h>
  67
  68 struct hfi1_ctxtdata;
  69 struct hfi1_pportdata;
  70 struct hfi1_devdata;
  71 struct hfi1_packet;
  72
  73 #include "iowait.h"
  74
  75 #define HFI1_MAX_RDMA_ATOMIC     16
  76
  77 /*
  78  * Increment this value if any changes that break userspace ABI
  79  * compatibility are made.
  80  */
  81 #define HFI1_UVERBS_ABI_VERSION       2
  82
  83 /* IB Performance Manager status values */
  84 #define IB_PMA_SAMPLE_STATUS_DONE       0x00
  85 #define IB_PMA_SAMPLE_STATUS_STARTED    0x01
  86 #define IB_PMA_SAMPLE_STATUS_RUNNING    0x02
  87
  88 /* Mandatory IB performance counter select values. */
  89 #define IB_PMA_PORT_XMIT_DATA   cpu_to_be16(0x0001)
  90 #define IB_PMA_PORT_RCV_DATA    cpu_to_be16(0x0002)
  91 #define IB_PMA_PORT_XMIT_PKTS   cpu_to_be16(0x0003)
  92 #define IB_PMA_PORT_RCV_PKTS    cpu_to_be16(0x0004)
  93 #define IB_PMA_PORT_XMIT_WAIT   cpu_to_be16(0x0005)
  94
  95 #define HFI1_VENDOR_IPG         cpu_to_be16(0xFFA0)
  96
  97 #define IB_DEFAULT_GID_PREFIX   cpu_to_be64(0xfe80000000000000ULL)
  98 #define OPA_BTH_MIG_REQ         BIT(31)
  99
 100 #define RC_OP(x) IB_OPCODE_RC_##x
 101 #define UC_OP(x) IB_OPCODE_UC_##x
 102
 103 /* flags passed by hfi1_ib_rcv() */
 104 enum {
 105         HFI1_HAS_GRH = (1 << 0),
 106 };
 107
 108 #define LRH_16B_BYTES (FIELD_SIZEOF(struct hfi1_16b_header, lrh))
 109 #define LRH_16B_DWORDS (LRH_16B_BYTES / sizeof(u32))
 110 #define LRH_9B_BYTES (FIELD_SIZEOF(struct ib_header, lrh))
 111 #define LRH_9B_DWORDS (LRH_9B_BYTES / sizeof(u32))
 112
 113 struct hfi1_16b_header {
 114         u32 lrh[4];
 115         union {
 116                 struct {
 117                         struct ib_grh grh;
 118                         struct ib_other_headers oth;
 119                 } l;
 120                 struct ib_other_headers oth;
 121         } u;
 122 } __packed;
 123
 124 struct hfi1_opa_header {
 125         union {
 126                 struct ib_header ibh; /* 9B header */
 127                 struct hfi1_16b_header opah; /* 16B header */
 128         };
 129         u8 hdr_type; /* 9B or 16B */
 130 } __packed;
 131
 132 struct hfi1_ahg_info {
 133         u32 ahgdesc[2];
 134         u16 tx_flags;
 135         u8 ahgcount;
 136         u8 ahgidx;
 137 };
 138
 139 struct hfi1_sdma_header {
 140         __le64 pbc;
 141         struct hfi1_opa_header hdr;
 142 } __packed;
 143
 144 /*
 145  * hfi1 specific data structures that will be hidden from rvt after the queue
 146  * pair is made common
 147  */
 148 struct hfi1_qp_priv {
 149         struct hfi1_ahg_info *s_ahg;              /* ahg info for next header */
 150         struct sdma_engine *s_sde;                /* current sde */
 151         struct send_context *s_sendcontext;       /* current sendcontext */
 152         u8 s_sc;                                  /* SC[0..4] for next packet */
 153         struct iowait s_iowait;
 154         struct rvt_qp *owner;
 155         u8 hdr_type; /* 9B or 16B */
 156 };
 157
 158 /*
 159  * This structure is used to hold commonly lookedup and computed values during
 160  * the send engine progress.
 161  */
 162 struct hfi1_pkt_state {
 163         struct hfi1_ibdev *dev;
 164         struct hfi1_ibport *ibp;
 165         struct hfi1_pportdata *ppd;
 166         struct verbs_txreq *s_txreq;
 167         unsigned long flags;
 168         unsigned long timeout;
 169         unsigned long timeout_int;
 170         int cpu;
 171         u8 opcode;
 172         bool in_thread;
 173         bool pkts_sent;
 174 };
 175
 176 #define HFI1_PSN_CREDIT  16
 177
 178 struct hfi1_opcode_stats {
 179         u64 n_packets;          /* number of packets */
 180         u64 n_bytes;            /* total number of bytes */
 181 };
 182
 183 struct hfi1_opcode_stats_perctx {
 184         struct hfi1_opcode_stats stats[256];
 185 };
 186
 187 static inline void inc_opstats(
 188         u32 tlen,
 189         struct hfi1_opcode_stats *stats)
 190 {
 191 #ifdef CONFIG_DEBUG_FS
 192         stats->n_bytes += tlen;
 193         stats->n_packets++;
 194 #endif
 195 }
 196
 197 struct hfi1_ibport {
 198         struct rvt_qp __rcu *qp[2];
 199         struct rvt_ibport rvp;
 200
 201         /* the first 16 entries are sl_to_vl for !OPA */
 202         u8 sl_to_sc[32];
 203         u8 sc_to_sl[32];
 204 };
 205
 206 struct hfi1_ibdev {
 207         struct rvt_dev_info rdi; /* Must be first */
 208
 209         /* QP numbers are shared by all IB ports */
 210         /* protect txwait list */
 211         seqlock_t txwait_lock ____cacheline_aligned_in_smp;
 212         struct list_head txwait;        /* list for wait verbs_txreq */
 213         struct list_head memwait;       /* list for wait kernel memory */
 214         struct kmem_cache *verbs_txreq_cache;
 215         u64 n_txwait;
 216         u64 n_kmem_wait;
 217
 218         /* protect iowait lists */
 219         seqlock_t iowait_lock ____cacheline_aligned_in_smp;
 220         u64 n_piowait;
 221         u64 n_piodrain;
 222         struct timer_list mem_timer;
 223
 224 #ifdef CONFIG_DEBUG_FS
 225         /* per HFI debugfs */
 226         struct dentry *hfi1_ibdev_dbg;
 227         /* per HFI symlinks to above */
 228         struct dentry *hfi1_ibdev_link;
 229 #ifdef CONFIG_FAULT_INJECTION
 230         struct fault_opcode *fault_opcode;
 231         struct fault_packet *fault_packet;
 232         bool fault_suppress_err;
 233 #endif
 234 #endif
 235 };
 236
 237 static inline struct hfi1_ibdev *to_idev(struct ib_device *ibdev)
 238 {
 239         struct rvt_dev_info *rdi;
 240
 241         rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
 242         return container_of(rdi, struct hfi1_ibdev, rdi);
 243 }
 244
 245 static inline struct rvt_qp *iowait_to_qp(struct  iowait *s_iowait)
 246 {
 247         struct hfi1_qp_priv *priv;
 248
 249         priv = container_of(s_iowait, struct hfi1_qp_priv, s_iowait);
 250         return priv->owner;
 251 }
 252
 253 /*
 254  * This must be called with s_lock held.
 255  */
 256 void hfi1_bad_pkey(struct hfi1_ibport *ibp, u32 key, u32 sl,
 257                    u32 qp1, u32 qp2, u32 lid1, u32 lid2);
 258 void hfi1_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
 259 void hfi1_sys_guid_chg(struct hfi1_ibport *ibp);
 260 void hfi1_node_desc_chg(struct hfi1_ibport *ibp);
 261 int hfi1_process_mad(struct ib_device *ibdev, int mad_flags, u8 port,
 262                      const struct ib_wc *in_wc, const struct ib_grh *in_grh,
 263                      const struct ib_mad_hdr *in_mad, size_t in_mad_size,
 264                      struct ib_mad_hdr *out_mad, size_t *out_mad_size,
 265                      u16 *out_mad_pkey_index);
 266
 267 /*
 268  * The PSN_MASK and PSN_SHIFT allow for
 269  * 1) comparing two PSNs
 270  * 2) returning the PSN with any upper bits masked
 271  * 3) returning the difference between to PSNs
 272  *
 273  * The number of significant bits in the PSN must
 274  * necessarily be at least one bit less than
 275  * the container holding the PSN.
 276  */
 277 #define PSN_MASK 0x7FFFFFFF
 278 #define PSN_SHIFT 1
 279 #define PSN_MODIFY_MASK 0xFFFFFF
 280
 281 /*
 282  * Compare two PSNs
 283  * Returns an integer <, ==, or > than zero.
 284  */
 285 static inline int cmp_psn(u32 a, u32 b)
 286 {
 287         return (((int)a) - ((int)b)) << PSN_SHIFT;
 288 }
 289
 290 /*
 291  * Return masked PSN
 292  */
 293 static inline u32 mask_psn(u32 a)
 294 {
 295         return a & PSN_MASK;
 296 }
 297
 298 /*
 299  * Return delta between two PSNs
 300  */
 301 static inline u32 delta_psn(u32 a, u32 b)
 302 {
 303         return (((int)a - (int)b) << PSN_SHIFT) >> PSN_SHIFT;
 304 }
 305
 306 struct verbs_txreq;
 307 void hfi1_put_txreq(struct verbs_txreq *tx);
 308
 309 int hfi1_verbs_send(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 310
 311 void hfi1_copy_sge(struct rvt_sge_state *ss, void *data, u32 length,
 312                    bool release, bool copy_last);
 313
 314 void hfi1_cnp_rcv(struct hfi1_packet *packet);
 315
 316 void hfi1_uc_rcv(struct hfi1_packet *packet);
 317
 318 void hfi1_rc_rcv(struct hfi1_packet *packet);
 319
 320 void hfi1_rc_hdrerr(
 321         struct hfi1_ctxtdata *rcd,
 322         struct hfi1_packet *packet,
 323         struct rvt_qp *qp);
 324
 325 u8 ah_to_sc(struct ib_device *ibdev, struct rdma_ah_attr *ah_attr);
 326
 327 void hfi1_rc_send_complete(struct rvt_qp *qp, struct hfi1_opa_header *opah);
 328
 329 void hfi1_ud_rcv(struct hfi1_packet *packet);
 330
 331 int hfi1_lookup_pkey_idx(struct hfi1_ibport *ibp, u16 pkey);
 332
 333 int hfi1_rvt_get_rwqe(struct rvt_qp *qp, int wr_id_only);
 334
 335 void hfi1_migrate_qp(struct rvt_qp *qp);
 336
 337 int hfi1_check_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
 338                          int attr_mask, struct ib_udata *udata);
 339
 340 void hfi1_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
 341                     int attr_mask, struct ib_udata *udata);
 342 void hfi1_restart_rc(struct rvt_qp *qp, u32 psn, int wait);
 343 int hfi1_check_send_wqe(struct rvt_qp *qp, struct rvt_swqe *wqe);
 344
 345 extern const u32 rc_only_opcode;
 346 extern const u32 uc_only_opcode;
 347
 348 int hfi1_ruc_check_hdr(struct hfi1_ibport *ibp, struct hfi1_packet *packet);
 349
 350 u32 hfi1_make_grh(struct hfi1_ibport *ibp, struct ib_grh *hdr,
 351                   const struct ib_global_route *grh, u32 hwords, u32 nwords);
 352
 353 void hfi1_make_ruc_header(struct rvt_qp *qp, struct ib_other_headers *ohdr,
 354                           u32 bth0, u32 bth2, int middle,
 355                           struct hfi1_pkt_state *ps);
 356
 357 void _hfi1_do_send(struct work_struct *work);
 358
 359 void hfi1_do_send_from_rvt(struct rvt_qp *qp);
 360
 361 void hfi1_do_send(struct rvt_qp *qp, bool in_thread);
 362
 363 void hfi1_send_complete(struct rvt_qp *qp, struct rvt_swqe *wqe,
 364                         enum ib_wc_status status);
 365
 366 void hfi1_send_rc_ack(struct hfi1_packet *packet, bool is_fecn);
 367
 368 int hfi1_make_rc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 369
 370 int hfi1_make_uc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 371
 372 int hfi1_make_ud_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 373
 374 int hfi1_register_ib_device(struct hfi1_devdata *);
 375
 376 void hfi1_unregister_ib_device(struct hfi1_devdata *);
 377
 378 void hfi1_ib_rcv(struct hfi1_packet *packet);
 379
 380 void hfi1_16B_rcv(struct hfi1_packet *packet);
 381
 382 unsigned hfi1_get_npkeys(struct hfi1_devdata *);
 383
 384 int hfi1_verbs_send_dma(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
 385                         u64 pbc);
 386
 387 int hfi1_verbs_send_pio(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
 388                         u64 pbc);
 389
 390 int hfi1_wss_init(void);
 391 void hfi1_wss_exit(void);
 392
 393 /* platform specific: return the lowest level cache (llc) size, in KiB */
 394 static inline int wss_llc_size(void)
 395 {
 396         /* assume that the boot CPU value is universal for all CPUs */
 397         return boot_cpu_data.x86_cache_size;
 398 }
 399
 400 /* platform specific: cacheless copy */
 401 static inline void cacheless_memcpy(void *dst, void *src, size_t n)
 402 {
 403         /*
 404          * Use the only available X64 cacheless copy.  Add a __user cast
 405          * to quiet sparse.  The src agument is already in the kernel so
 406          * there are no security issues.  The extra fault recovery machinery
 407          * is not invoked.
 408          */
 409         __copy_user_nocache(dst, (void __user *)src, n, 0);
 410 }
 411
 412 static inline bool opa_bth_is_migration(struct ib_other_headers *ohdr)
 413 {
 414         return ohdr->bth[1] & cpu_to_be32(OPA_BTH_MIG_REQ);
 415 }
 416
 417 extern const enum ib_wc_opcode ib_hfi1_wc_opcode[];
 418
 419 extern const u8 hdr_len_by_opcode[];
 420
 421 extern const int ib_rvt_state_ops[];
 422
 423 extern __be64 ib_hfi1_sys_image_guid;    /* in network order */
 424
 425 extern unsigned int hfi1_max_cqes;
 426
 427 extern unsigned int hfi1_max_cqs;
 428
 429 extern unsigned int hfi1_max_qp_wrs;
 430
 431 extern unsigned int hfi1_max_qps;
 432
 433 extern unsigned int hfi1_max_sges;
 434
 435 extern unsigned int hfi1_max_mcast_grps;
 436
 437 extern unsigned int hfi1_max_mcast_qp_attached;
 438
 439 extern unsigned int hfi1_max_srqs;
 440
 441 extern unsigned int hfi1_max_srq_sges;
 442
 443 extern unsigned int hfi1_max_srq_wrs;
 444
 445 extern unsigned short piothreshold;
 446
 447 extern const u32 ib_hfi1_rnr_table[];
 448
 449 #endif                          /* HFI1_VERBS_H */