drivers/infiniband/hw/hfi1/verbs.h

   1 /*
   2  * Copyright(c) 2015, 2016 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 #define HFI1_GUIDS_PER_PORT     5
  77
  78 /*
  79  * Increment this value if any changes that break userspace ABI
  80  * compatibility are made.
  81  */
  82 #define HFI1_UVERBS_ABI_VERSION       2
  83
  84 /* IB Performance Manager status values */
  85 #define IB_PMA_SAMPLE_STATUS_DONE       0x00
  86 #define IB_PMA_SAMPLE_STATUS_STARTED    0x01
  87 #define IB_PMA_SAMPLE_STATUS_RUNNING    0x02
  88
  89 /* Mandatory IB performance counter select values. */
  90 #define IB_PMA_PORT_XMIT_DATA   cpu_to_be16(0x0001)
  91 #define IB_PMA_PORT_RCV_DATA    cpu_to_be16(0x0002)
  92 #define IB_PMA_PORT_XMIT_PKTS   cpu_to_be16(0x0003)
  93 #define IB_PMA_PORT_RCV_PKTS    cpu_to_be16(0x0004)
  94 #define IB_PMA_PORT_XMIT_WAIT   cpu_to_be16(0x0005)
  95
  96 #define HFI1_VENDOR_IPG         cpu_to_be16(0xFFA0)
  97
  98 #define IB_DEFAULT_GID_PREFIX   cpu_to_be64(0xfe80000000000000ULL)
  99
 100 /* flags passed by hfi1_ib_rcv() */
 101 enum {
 102         HFI1_HAS_GRH = (1 << 0),
 103 };
 104
 105 struct hfi1_ahg_info {
 106         u32 ahgdesc[2];
 107         u16 tx_flags;
 108         u8 ahgcount;
 109         u8 ahgidx;
 110 };
 111
 112 struct hfi1_sdma_header {
 113         __le64 pbc;
 114         struct ib_header hdr;
 115 } __packed;
 116
 117 /*
 118  * hfi1 specific data structures that will be hidden from rvt after the queue
 119  * pair is made common
 120  */
 121 struct hfi1_qp_priv {
 122         struct hfi1_ahg_info *s_ahg;              /* ahg info for next header */
 123         struct sdma_engine *s_sde;                /* current sde */
 124         struct send_context *s_sendcontext;       /* current sendcontext */
 125         u8 s_sc;                                  /* SC[0..4] for next packet */
 126         u8 r_adefered;                            /* number of acks defered */
 127         struct iowait s_iowait;
 128         struct timer_list s_rnr_timer;
 129         struct rvt_qp *owner;
 130 };
 131
 132 /*
 133  * This structure is used to hold commonly lookedup and computed values during
 134  * the send engine progress.
 135  */
 136 struct hfi1_pkt_state {
 137         struct hfi1_ibdev *dev;
 138         struct hfi1_ibport *ibp;
 139         struct hfi1_pportdata *ppd;
 140         struct verbs_txreq *s_txreq;
 141         unsigned long flags;
 142 };
 143
 144 #define HFI1_PSN_CREDIT  16
 145
 146 struct hfi1_opcode_stats {
 147         u64 n_packets;          /* number of packets */
 148         u64 n_bytes;            /* total number of bytes */
 149 };
 150
 151 struct hfi1_opcode_stats_perctx {
 152         struct hfi1_opcode_stats stats[256];
 153 };
 154
 155 static inline void inc_opstats(
 156         u32 tlen,
 157         struct hfi1_opcode_stats *stats)
 158 {
 159 #ifdef CONFIG_DEBUG_FS
 160         stats->n_bytes += tlen;
 161         stats->n_packets++;
 162 #endif
 163 }
 164
 165 struct hfi1_ibport {
 166         struct rvt_qp __rcu *qp[2];
 167         struct rvt_ibport rvp;
 168
 169         __be64 guids[HFI1_GUIDS_PER_PORT        - 1];   /* writable GUIDs */
 170
 171         /* the first 16 entries are sl_to_vl for !OPA */
 172         u8 sl_to_sc[32];
 173         u8 sc_to_sl[32];
 174 };
 175
 176 struct hfi1_ibdev {
 177         struct rvt_dev_info rdi; /* Must be first */
 178
 179         /* QP numbers are shared by all IB ports */
 180         /* protect wait lists */
 181         seqlock_t iowait_lock;
 182         struct list_head txwait;        /* list for wait verbs_txreq */
 183         struct list_head memwait;       /* list for wait kernel memory */
 184         struct list_head txreq_free;
 185         struct kmem_cache *verbs_txreq_cache;
 186         struct timer_list mem_timer;
 187
 188         u64 n_piowait;
 189         u64 n_piodrain;
 190         u64 n_txwait;
 191         u64 n_kmem_wait;
 192
 193 #ifdef CONFIG_DEBUG_FS
 194         /* per HFI debugfs */
 195         struct dentry *hfi1_ibdev_dbg;
 196         /* per HFI symlinks to above */
 197         struct dentry *hfi1_ibdev_link;
 198 #endif
 199 };
 200
 201 static inline struct hfi1_ibdev *to_idev(struct ib_device *ibdev)
 202 {
 203         struct rvt_dev_info *rdi;
 204
 205         rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
 206         return container_of(rdi, struct hfi1_ibdev, rdi);
 207 }
 208
 209 static inline struct rvt_qp *iowait_to_qp(struct  iowait *s_iowait)
 210 {
 211         struct hfi1_qp_priv *priv;
 212
 213         priv = container_of(s_iowait, struct hfi1_qp_priv, s_iowait);
 214         return priv->owner;
 215 }
 216
 217 /*
 218  * Send if not busy or waiting for I/O and either
 219  * a RC response is pending or we can process send work requests.
 220  */
 221 static inline int hfi1_send_ok(struct rvt_qp *qp)
 222 {
 223         return !(qp->s_flags & (RVT_S_BUSY | RVT_S_ANY_WAIT_IO)) &&
 224                 (qp->s_hdrwords || (qp->s_flags & RVT_S_RESP_PENDING) ||
 225                  !(qp->s_flags & RVT_S_ANY_WAIT_SEND));
 226 }
 227
 228 /*
 229  * This must be called with s_lock held.
 230  */
 231 void hfi1_bad_pqkey(struct hfi1_ibport *ibp, __be16 trap_num, u32 key, u32 sl,
 232                     u32 qp1, u32 qp2, u16 lid1, u16 lid2);
 233 void hfi1_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
 234 void hfi1_sys_guid_chg(struct hfi1_ibport *ibp);
 235 void hfi1_node_desc_chg(struct hfi1_ibport *ibp);
 236 int hfi1_process_mad(struct ib_device *ibdev, int mad_flags, u8 port,
 237                      const struct ib_wc *in_wc, const struct ib_grh *in_grh,
 238                      const struct ib_mad_hdr *in_mad, size_t in_mad_size,
 239                      struct ib_mad_hdr *out_mad, size_t *out_mad_size,
 240                      u16 *out_mad_pkey_index);
 241
 242 /*
 243  * The PSN_MASK and PSN_SHIFT allow for
 244  * 1) comparing two PSNs
 245  * 2) returning the PSN with any upper bits masked
 246  * 3) returning the difference between to PSNs
 247  *
 248  * The number of significant bits in the PSN must
 249  * necessarily be at least one bit less than
 250  * the container holding the PSN.
 251  */
 252 #ifndef CONFIG_HFI1_VERBS_31BIT_PSN
 253 #define PSN_MASK 0xFFFFFF
 254 #define PSN_SHIFT 8
 255 #else
 256 #define PSN_MASK 0x7FFFFFFF
 257 #define PSN_SHIFT 1
 258 #endif
 259 #define PSN_MODIFY_MASK 0xFFFFFF
 260
 261 /*
 262  * Compare the lower 24 bits of the msn values.
 263  * Returns an integer <, ==, or > than zero.
 264  */
 265 static inline int cmp_msn(u32 a, u32 b)
 266 {
 267         return (((int)a) - ((int)b)) << 8;
 268 }
 269
 270 /*
 271  * Compare two PSNs
 272  * Returns an integer <, ==, or > than zero.
 273  */
 274 static inline int cmp_psn(u32 a, u32 b)
 275 {
 276         return (((int)a) - ((int)b)) << PSN_SHIFT;
 277 }
 278
 279 /*
 280  * Return masked PSN
 281  */
 282 static inline u32 mask_psn(u32 a)
 283 {
 284         return a & PSN_MASK;
 285 }
 286
 287 /*
 288  * Return delta between two PSNs
 289  */
 290 static inline u32 delta_psn(u32 a, u32 b)
 291 {
 292         return (((int)a - (int)b) << PSN_SHIFT) >> PSN_SHIFT;
 293 }
 294
 295 struct verbs_txreq;
 296 void hfi1_put_txreq(struct verbs_txreq *tx);
 297
 298 int hfi1_verbs_send(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 299
 300 void hfi1_copy_sge(struct rvt_sge_state *ss, void *data, u32 length,
 301                    int release, int copy_last);
 302
 303 void hfi1_skip_sge(struct rvt_sge_state *ss, u32 length, int release);
 304
 305 void hfi1_cnp_rcv(struct hfi1_packet *packet);
 306
 307 void hfi1_uc_rcv(struct hfi1_packet *packet);
 308
 309 void hfi1_rc_rcv(struct hfi1_packet *packet);
 310
 311 void hfi1_rc_hdrerr(
 312         struct hfi1_ctxtdata *rcd,
 313         struct ib_header *hdr,
 314         u32 rcv_flags,
 315         struct rvt_qp *qp);
 316
 317 u8 ah_to_sc(struct ib_device *ibdev, struct ib_ah_attr *ah_attr);
 318
 319 struct ib_ah *hfi1_create_qp0_ah(struct hfi1_ibport *ibp, u16 dlid);
 320
 321 void hfi1_rc_rnr_retry(unsigned long arg);
 322 void hfi1_add_rnr_timer(struct rvt_qp *qp, u32 to);
 323 void hfi1_rc_timeout(unsigned long arg);
 324 void hfi1_del_timers_sync(struct rvt_qp *qp);
 325 void hfi1_stop_rc_timers(struct rvt_qp *qp);
 326
 327 void hfi1_rc_send_complete(struct rvt_qp *qp, struct ib_header *hdr);
 328
 329 void hfi1_rc_error(struct rvt_qp *qp, enum ib_wc_status err);
 330
 331 void hfi1_ud_rcv(struct hfi1_packet *packet);
 332
 333 int hfi1_lookup_pkey_idx(struct hfi1_ibport *ibp, u16 pkey);
 334
 335 int hfi1_rvt_get_rwqe(struct rvt_qp *qp, int wr_id_only);
 336
 337 void hfi1_migrate_qp(struct rvt_qp *qp);
 338
 339 int hfi1_check_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
 340                          int attr_mask, struct ib_udata *udata);
 341
 342 void hfi1_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
 343                     int attr_mask, struct ib_udata *udata);
 344
 345 int hfi1_check_send_wqe(struct rvt_qp *qp, struct rvt_swqe *wqe);
 346
 347 extern const u32 rc_only_opcode;
 348 extern const u32 uc_only_opcode;
 349
 350 static inline u8 get_opcode(struct ib_header *h)
 351 {
 352         u16 lnh = be16_to_cpu(h->lrh[0]) & 3;
 353
 354         if (lnh == IB_LNH_IBA_LOCAL)
 355                 return be32_to_cpu(h->u.oth.bth[0]) >> 24;
 356         else
 357                 return be32_to_cpu(h->u.l.oth.bth[0]) >> 24;
 358 }
 359
 360 int hfi1_ruc_check_hdr(struct hfi1_ibport *ibp, struct ib_header *hdr,
 361                        int has_grh, struct rvt_qp *qp, u32 bth0);
 362
 363 u32 hfi1_make_grh(struct hfi1_ibport *ibp, struct ib_grh *hdr,
 364                   struct ib_global_route *grh, u32 hwords, u32 nwords);
 365
 366 void hfi1_make_ruc_header(struct rvt_qp *qp, struct ib_other_headers *ohdr,
 367                           u32 bth0, u32 bth2, int middle,
 368                           struct hfi1_pkt_state *ps);
 369
 370 void _hfi1_do_send(struct work_struct *work);
 371
 372 void hfi1_do_send(struct rvt_qp *qp);
 373
 374 void hfi1_send_complete(struct rvt_qp *qp, struct rvt_swqe *wqe,
 375                         enum ib_wc_status status);
 376
 377 void hfi1_send_rc_ack(struct hfi1_ctxtdata *, struct rvt_qp *qp, int is_fecn);
 378
 379 int hfi1_make_rc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 380
 381 int hfi1_make_uc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 382
 383 int hfi1_make_ud_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
 384
 385 int hfi1_register_ib_device(struct hfi1_devdata *);
 386
 387 void hfi1_unregister_ib_device(struct hfi1_devdata *);
 388
 389 void hfi1_ib_rcv(struct hfi1_packet *packet);
 390
 391 unsigned hfi1_get_npkeys(struct hfi1_devdata *);
 392
 393 int hfi1_verbs_send_dma(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
 394                         u64 pbc);
 395
 396 int hfi1_verbs_send_pio(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
 397                         u64 pbc);
 398
 399 int hfi1_wss_init(void);
 400 void hfi1_wss_exit(void);
 401
 402 /* platform specific: return the lowest level cache (llc) size, in KiB */
 403 static inline int wss_llc_size(void)
 404 {
 405         /* assume that the boot CPU value is universal for all CPUs */
 406         return boot_cpu_data.x86_cache_size;
 407 }
 408
 409 /* platform specific: cacheless copy */
 410 static inline void cacheless_memcpy(void *dst, void *src, size_t n)
 411 {
 412         /*
 413          * Use the only available X64 cacheless copy.  Add a __user cast
 414          * to quiet sparse.  The src agument is already in the kernel so
 415          * there are no security issues.  The extra fault recovery machinery
 416          * is not invoked.
 417          */
 418         __copy_user_nocache(dst, (void __user *)src, n, 0);
 419 }
 420
 421 extern const enum ib_wc_opcode ib_hfi1_wc_opcode[];
 422
 423 extern const u8 hdr_len_by_opcode[];
 424
 425 extern const int ib_rvt_state_ops[];
 426
 427 extern __be64 ib_hfi1_sys_image_guid;    /* in network order */
 428
 429 extern unsigned int hfi1_max_cqes;
 430
 431 extern unsigned int hfi1_max_cqs;
 432
 433 extern unsigned int hfi1_max_qp_wrs;
 434
 435 extern unsigned int hfi1_max_qps;
 436
 437 extern unsigned int hfi1_max_sges;
 438
 439 extern unsigned int hfi1_max_mcast_grps;
 440
 441 extern unsigned int hfi1_max_mcast_qp_attached;
 442
 443 extern unsigned int hfi1_max_srqs;
 444
 445 extern unsigned int hfi1_max_srq_sges;
 446
 447 extern unsigned int hfi1_max_srq_wrs;
 448
 449 extern unsigned short piothreshold;
 450
 451 extern const u32 ib_hfi1_rnr_table[];
 452
 453 #endif                          /* HFI1_VERBS_H */