xref: /linux/drivers/infiniband/hw/hfi1/verbs.h (revision 9905bf06e890c2a845ac8fd19d7e6b8987ef8df6)
1 /*
2  * Copyright(c) 2015 - 2018 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 #include "tid_rdma.h"
75 #include "opfn.h"
76 
77 #define HFI1_MAX_RDMA_ATOMIC     16
78 
79 /*
80  * Increment this value if any changes that break userspace ABI
81  * compatibility are made.
82  */
83 #define HFI1_UVERBS_ABI_VERSION       2
84 
85 /* IB Performance Manager status values */
86 #define IB_PMA_SAMPLE_STATUS_DONE       0x00
87 #define IB_PMA_SAMPLE_STATUS_STARTED    0x01
88 #define IB_PMA_SAMPLE_STATUS_RUNNING    0x02
89 
90 /* Mandatory IB performance counter select values. */
91 #define IB_PMA_PORT_XMIT_DATA   cpu_to_be16(0x0001)
92 #define IB_PMA_PORT_RCV_DATA    cpu_to_be16(0x0002)
93 #define IB_PMA_PORT_XMIT_PKTS   cpu_to_be16(0x0003)
94 #define IB_PMA_PORT_RCV_PKTS    cpu_to_be16(0x0004)
95 #define IB_PMA_PORT_XMIT_WAIT   cpu_to_be16(0x0005)
96 
97 #define HFI1_VENDOR_IPG		cpu_to_be16(0xFFA0)
98 
99 #define IB_DEFAULT_GID_PREFIX	cpu_to_be64(0xfe80000000000000ULL)
100 #define OPA_BTH_MIG_REQ		BIT(31)
101 
102 #define RC_OP(x) IB_OPCODE_RC_##x
103 #define UC_OP(x) IB_OPCODE_UC_##x
104 
105 /* flags passed by hfi1_ib_rcv() */
106 enum {
107 	HFI1_HAS_GRH = (1 << 0),
108 };
109 
110 #define LRH_16B_BYTES (FIELD_SIZEOF(struct hfi1_16b_header, lrh))
111 #define LRH_16B_DWORDS (LRH_16B_BYTES / sizeof(u32))
112 #define LRH_9B_BYTES (FIELD_SIZEOF(struct ib_header, lrh))
113 #define LRH_9B_DWORDS (LRH_9B_BYTES / sizeof(u32))
114 
115 /* 24Bits for qpn, upper 8Bits reserved */
116 struct opa_16b_mgmt {
117 	__be32 dest_qpn;
118 	__be32 src_qpn;
119 };
120 
121 struct hfi1_16b_header {
122 	u32 lrh[4];
123 	union {
124 		struct {
125 			struct ib_grh grh;
126 			struct ib_other_headers oth;
127 		} l;
128 		struct ib_other_headers oth;
129 		struct opa_16b_mgmt mgmt;
130 	} u;
131 } __packed;
132 
133 struct hfi1_opa_header {
134 	union {
135 		struct ib_header ibh; /* 9B header */
136 		struct hfi1_16b_header opah; /* 16B header */
137 	};
138 	u8 hdr_type; /* 9B or 16B */
139 } __packed;
140 
141 struct hfi1_ahg_info {
142 	u32 ahgdesc[2];
143 	u16 tx_flags;
144 	u8 ahgcount;
145 	u8 ahgidx;
146 };
147 
148 struct hfi1_sdma_header {
149 	__le64 pbc;
150 	struct hfi1_opa_header hdr;
151 } __packed;
152 
153 /*
154  * hfi1 specific data structures that will be hidden from rvt after the queue
155  * pair is made common
156  */
157 struct hfi1_qp_priv {
158 	struct hfi1_ahg_info *s_ahg;              /* ahg info for next header */
159 	struct sdma_engine *s_sde;                /* current sde */
160 	struct send_context *s_sendcontext;       /* current sendcontext */
161 	struct hfi1_ctxtdata *rcd;                /* QP's receive context */
162 	struct page **pages;                      /* for TID page scan */
163 	u32 tid_enqueue;                          /* saved when tid waited */
164 	u8 s_sc;		                  /* SC[0..4] for next packet */
165 	struct iowait s_iowait;
166 	struct list_head tid_wait;                /* for queueing tid space */
167 	struct hfi1_opfn_data opfn;
168 	struct tid_flow_state flow_state;
169 	struct tid_rdma_qp_params tid_rdma;
170 	struct rvt_qp *owner;
171 	u8 hdr_type; /* 9B or 16B */
172 	unsigned long tid_timer_timeout_jiffies;
173 
174 	/* For TID RDMA READ */
175 	u32 tid_r_reqs;         /* Num of tid reads requested */
176 	u32 tid_r_comp;         /* Num of tid reads completed */
177 	u32 pending_tid_r_segs; /* Num of pending tid read segments */
178 	u16 pkts_ps;            /* packets per segment */
179 	u8 timeout_shift;       /* account for number of packets per segment */
180 };
181 
182 struct hfi1_swqe_priv {
183 	struct tid_rdma_request tid_req;
184 	struct rvt_sge_state ss;  /* Used for TID RDMA READ Request */
185 };
186 
187 struct hfi1_ack_priv {
188 	struct tid_rdma_request tid_req;
189 };
190 
191 /*
192  * This structure is used to hold commonly lookedup and computed values during
193  * the send engine progress.
194  */
195 struct iowait_work;
196 struct hfi1_pkt_state {
197 	struct hfi1_ibdev *dev;
198 	struct hfi1_ibport *ibp;
199 	struct hfi1_pportdata *ppd;
200 	struct verbs_txreq *s_txreq;
201 	struct iowait_work *wait;
202 	unsigned long flags;
203 	unsigned long timeout;
204 	unsigned long timeout_int;
205 	int cpu;
206 	u8 opcode;
207 	bool in_thread;
208 	bool pkts_sent;
209 };
210 
211 #define HFI1_PSN_CREDIT  16
212 
213 struct hfi1_opcode_stats {
214 	u64 n_packets;          /* number of packets */
215 	u64 n_bytes;            /* total number of bytes */
216 };
217 
218 struct hfi1_opcode_stats_perctx {
219 	struct hfi1_opcode_stats stats[256];
220 };
221 
222 static inline void inc_opstats(
223 	u32 tlen,
224 	struct hfi1_opcode_stats *stats)
225 {
226 #ifdef CONFIG_DEBUG_FS
227 	stats->n_bytes += tlen;
228 	stats->n_packets++;
229 #endif
230 }
231 
232 struct hfi1_ibport {
233 	struct rvt_qp __rcu *qp[2];
234 	struct rvt_ibport rvp;
235 
236 	/* the first 16 entries are sl_to_vl for !OPA */
237 	u8 sl_to_sc[32];
238 	u8 sc_to_sl[32];
239 };
240 
241 struct hfi1_ibdev {
242 	struct rvt_dev_info rdi; /* Must be first */
243 
244 	/* QP numbers are shared by all IB ports */
245 	/* protect txwait list */
246 	seqlock_t txwait_lock ____cacheline_aligned_in_smp;
247 	struct list_head txwait;        /* list for wait verbs_txreq */
248 	struct list_head memwait;       /* list for wait kernel memory */
249 	struct kmem_cache *verbs_txreq_cache;
250 	u64 n_txwait;
251 	u64 n_kmem_wait;
252 	u64 n_tidwait;
253 
254 	/* protect iowait lists */
255 	seqlock_t iowait_lock ____cacheline_aligned_in_smp;
256 	u64 n_piowait;
257 	u64 n_piodrain;
258 	struct timer_list mem_timer;
259 
260 #ifdef CONFIG_DEBUG_FS
261 	/* per HFI debugfs */
262 	struct dentry *hfi1_ibdev_dbg;
263 	/* per HFI symlinks to above */
264 	struct dentry *hfi1_ibdev_link;
265 #ifdef CONFIG_FAULT_INJECTION
266 	struct fault *fault;
267 #endif
268 #endif
269 };
270 
271 static inline struct hfi1_ibdev *to_idev(struct ib_device *ibdev)
272 {
273 	struct rvt_dev_info *rdi;
274 
275 	rdi = container_of(ibdev, struct rvt_dev_info, ibdev);
276 	return container_of(rdi, struct hfi1_ibdev, rdi);
277 }
278 
279 static inline struct rvt_qp *iowait_to_qp(struct iowait *s_iowait)
280 {
281 	struct hfi1_qp_priv *priv;
282 
283 	priv = container_of(s_iowait, struct hfi1_qp_priv, s_iowait);
284 	return priv->owner;
285 }
286 
287 /*
288  * This must be called with s_lock held.
289  */
290 void hfi1_bad_pkey(struct hfi1_ibport *ibp, u32 key, u32 sl,
291 		   u32 qp1, u32 qp2, u32 lid1, u32 lid2);
292 void hfi1_cap_mask_chg(struct rvt_dev_info *rdi, u8 port_num);
293 void hfi1_sys_guid_chg(struct hfi1_ibport *ibp);
294 void hfi1_node_desc_chg(struct hfi1_ibport *ibp);
295 int hfi1_process_mad(struct ib_device *ibdev, int mad_flags, u8 port,
296 		     const struct ib_wc *in_wc, const struct ib_grh *in_grh,
297 		     const struct ib_mad_hdr *in_mad, size_t in_mad_size,
298 		     struct ib_mad_hdr *out_mad, size_t *out_mad_size,
299 		     u16 *out_mad_pkey_index);
300 
301 /*
302  * The PSN_MASK and PSN_SHIFT allow for
303  * 1) comparing two PSNs
304  * 2) returning the PSN with any upper bits masked
305  * 3) returning the difference between to PSNs
306  *
307  * The number of significant bits in the PSN must
308  * necessarily be at least one bit less than
309  * the container holding the PSN.
310  */
311 #define PSN_MASK 0x7FFFFFFF
312 #define PSN_SHIFT 1
313 #define PSN_MODIFY_MASK 0xFFFFFF
314 
315 /*
316  * Compare two PSNs
317  * Returns an integer <, ==, or > than zero.
318  */
319 static inline int cmp_psn(u32 a, u32 b)
320 {
321 	return (((int)a) - ((int)b)) << PSN_SHIFT;
322 }
323 
324 /*
325  * Return masked PSN
326  */
327 static inline u32 mask_psn(u32 a)
328 {
329 	return a & PSN_MASK;
330 }
331 
332 /*
333  * Return delta between two PSNs
334  */
335 static inline u32 delta_psn(u32 a, u32 b)
336 {
337 	return (((int)a - (int)b) << PSN_SHIFT) >> PSN_SHIFT;
338 }
339 
340 static inline struct tid_rdma_request *wqe_to_tid_req(struct rvt_swqe *wqe)
341 {
342 	return &((struct hfi1_swqe_priv *)wqe->priv)->tid_req;
343 }
344 
345 static inline struct tid_rdma_request *ack_to_tid_req(struct rvt_ack_entry *e)
346 {
347 	return &((struct hfi1_ack_priv *)e->priv)->tid_req;
348 }
349 
350 /*
351  * Look through all the active flows for a TID RDMA request and find
352  * the one (if it exists) that contains the specified PSN.
353  */
354 static inline u32 __full_flow_psn(struct flow_state *state, u32 psn)
355 {
356 	return mask_psn((state->generation << HFI1_KDETH_BTH_SEQ_SHIFT) |
357 			(psn & HFI1_KDETH_BTH_SEQ_MASK));
358 }
359 
360 static inline u32 full_flow_psn(struct tid_rdma_flow *flow, u32 psn)
361 {
362 	return __full_flow_psn(&flow->flow_state, psn);
363 }
364 
365 struct verbs_txreq;
366 void hfi1_put_txreq(struct verbs_txreq *tx);
367 
368 int hfi1_verbs_send(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
369 
370 void hfi1_cnp_rcv(struct hfi1_packet *packet);
371 
372 void hfi1_uc_rcv(struct hfi1_packet *packet);
373 
374 void hfi1_rc_rcv(struct hfi1_packet *packet);
375 
376 void hfi1_rc_hdrerr(
377 	struct hfi1_ctxtdata *rcd,
378 	struct hfi1_packet *packet,
379 	struct rvt_qp *qp);
380 
381 u8 ah_to_sc(struct ib_device *ibdev, struct rdma_ah_attr *ah_attr);
382 
383 void hfi1_rc_send_complete(struct rvt_qp *qp, struct hfi1_opa_header *opah);
384 
385 void hfi1_ud_rcv(struct hfi1_packet *packet);
386 
387 int hfi1_lookup_pkey_idx(struct hfi1_ibport *ibp, u16 pkey);
388 
389 void hfi1_migrate_qp(struct rvt_qp *qp);
390 
391 int hfi1_check_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
392 			 int attr_mask, struct ib_udata *udata);
393 
394 void hfi1_modify_qp(struct rvt_qp *qp, struct ib_qp_attr *attr,
395 		    int attr_mask, struct ib_udata *udata);
396 void hfi1_restart_rc(struct rvt_qp *qp, u32 psn, int wait);
397 int hfi1_setup_wqe(struct rvt_qp *qp, struct rvt_swqe *wqe,
398 		   bool *call_send);
399 
400 extern const u32 rc_only_opcode;
401 extern const u32 uc_only_opcode;
402 
403 int hfi1_ruc_check_hdr(struct hfi1_ibport *ibp, struct hfi1_packet *packet);
404 
405 u32 hfi1_make_grh(struct hfi1_ibport *ibp, struct ib_grh *hdr,
406 		  const struct ib_global_route *grh, u32 hwords, u32 nwords);
407 
408 void hfi1_make_ruc_header(struct rvt_qp *qp, struct ib_other_headers *ohdr,
409 			  u32 bth0, u32 bth1, u32 bth2, int middle,
410 			  struct hfi1_pkt_state *ps);
411 
412 void _hfi1_do_send(struct work_struct *work);
413 
414 void hfi1_do_send_from_rvt(struct rvt_qp *qp);
415 
416 void hfi1_do_send(struct rvt_qp *qp, bool in_thread);
417 
418 void hfi1_send_rc_ack(struct hfi1_packet *packet, bool is_fecn);
419 
420 int hfi1_make_rc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
421 
422 int hfi1_make_uc_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
423 
424 int hfi1_make_ud_req(struct rvt_qp *qp, struct hfi1_pkt_state *ps);
425 
426 int hfi1_register_ib_device(struct hfi1_devdata *);
427 
428 void hfi1_unregister_ib_device(struct hfi1_devdata *);
429 
430 void hfi1_ib_rcv(struct hfi1_packet *packet);
431 
432 void hfi1_16B_rcv(struct hfi1_packet *packet);
433 
434 unsigned hfi1_get_npkeys(struct hfi1_devdata *);
435 
436 int hfi1_verbs_send_dma(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
437 			u64 pbc);
438 
439 int hfi1_verbs_send_pio(struct rvt_qp *qp, struct hfi1_pkt_state *ps,
440 			u64 pbc);
441 
442 static inline bool opa_bth_is_migration(struct ib_other_headers *ohdr)
443 {
444 	return ohdr->bth[1] & cpu_to_be32(OPA_BTH_MIG_REQ);
445 }
446 
447 void hfi1_wait_kmem(struct rvt_qp *qp);
448 
449 static inline void hfi1_trdma_send_complete(struct rvt_qp *qp,
450 					    struct rvt_swqe *wqe,
451 					    enum ib_wc_status status)
452 {
453 	trdma_clean_swqe(qp, wqe);
454 	rvt_send_complete(qp, wqe, status);
455 }
456 
457 extern const enum ib_wc_opcode ib_hfi1_wc_opcode[];
458 
459 extern const u8 hdr_len_by_opcode[];
460 
461 extern const int ib_rvt_state_ops[];
462 
463 extern __be64 ib_hfi1_sys_image_guid;    /* in network order */
464 
465 extern unsigned int hfi1_max_cqes;
466 
467 extern unsigned int hfi1_max_cqs;
468 
469 extern unsigned int hfi1_max_qp_wrs;
470 
471 extern unsigned int hfi1_max_qps;
472 
473 extern unsigned int hfi1_max_sges;
474 
475 extern unsigned int hfi1_max_mcast_grps;
476 
477 extern unsigned int hfi1_max_mcast_qp_attached;
478 
479 extern unsigned int hfi1_max_srqs;
480 
481 extern unsigned int hfi1_max_srq_sges;
482 
483 extern unsigned int hfi1_max_srq_wrs;
484 
485 extern unsigned short piothreshold;
486 
487 extern const u32 ib_hfi1_rnr_table[];
488 
489 #endif                          /* HFI1_VERBS_H */
490