]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/staging/lustre/lnet/klnds/o2iblnd/o2iblnd.h
Merge 4.3-rc3 into staging-next
[karo-tx-linux.git] / drivers / staging / lustre / lnet / klnds / o2iblnd / o2iblnd.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lnet/klnds/o2iblnd/o2iblnd.h
37  *
38  * Author: Eric Barton <eric@bartonsoftware.com>
39  */
40
41 #include <linux/module.h>
42 #include <linux/kernel.h>
43 #include <linux/mm.h>
44 #include <linux/string.h>
45 #include <linux/stat.h>
46 #include <linux/errno.h>
47 #include <linux/unistd.h>
48 #include <linux/uio.h>
49 #include <linux/uaccess.h>
50
51 #include <linux/io.h>
52
53 #include <linux/fs.h>
54 #include <linux/file.h>
55 #include <linux/list.h>
56 #include <linux/kmod.h>
57 #include <linux/sysctl.h>
58 #include <linux/pci.h>
59
60 #include <net/sock.h>
61 #include <linux/in.h>
62
63 #define DEBUG_SUBSYSTEM S_LND
64
65 #include "../../../include/linux/libcfs/libcfs.h"
66 #include "../../../include/linux/lnet/lnet.h"
67 #include "../../../include/linux/lnet/lib-lnet.h"
68
69 #include <rdma/rdma_cm.h>
70 #include <rdma/ib_cm.h>
71 #include <rdma/ib_verbs.h>
72 #include <rdma/ib_fmr_pool.h>
73
74 #define IBLND_PEER_HASH_SIZE            101     /* # peer lists */
75 /* # scheduler loops before reschedule */
76 #define IBLND_RESCHED                   100
77
78 #define IBLND_N_SCHED                   2
79 #define IBLND_N_SCHED_HIGH              4
80
81 typedef struct {
82         int *kib_dev_failover;           /* HCA failover */
83         unsigned int *kib_service;       /* IB service number */
84         int *kib_min_reconnect_interval; /* first failed connection retry... */
85         int *kib_max_reconnect_interval; /* exponentially increasing to this */
86         int *kib_cksum;                  /* checksum kib_msg_t? */
87         int *kib_timeout;                /* comms timeout (seconds) */
88         int *kib_keepalive;              /* keepalive timeout (seconds) */
89         int *kib_ntx;                    /* # tx descs */
90         int *kib_credits;                /* # concurrent sends */
91         int *kib_peertxcredits;          /* # concurrent sends to 1 peer */
92         int *kib_peerrtrcredits;         /* # per-peer router buffer credits */
93         int *kib_peercredits_hiw;        /* # when eagerly to return credits */
94         int *kib_peertimeout;            /* seconds to consider peer dead */
95         char **kib_default_ipif;         /* default IPoIB interface */
96         int *kib_retry_count;
97         int *kib_rnr_retry_count;
98         int *kib_concurrent_sends;       /* send work queue sizing */
99         int *kib_ib_mtu;                 /* IB MTU */
100         int *kib_map_on_demand;          /* map-on-demand if RD has more */
101                                          /* fragments than this value, 0 */
102                                          /* disable map-on-demand */
103         int *kib_fmr_pool_size;          /* # FMRs in pool */
104         int *kib_fmr_flush_trigger;      /* When to trigger FMR flush */
105         int *kib_fmr_cache;              /* enable FMR pool cache? */
106         int *kib_require_priv_port;      /* accept only privileged ports */
107         int *kib_use_priv_port; /* use privileged port for active connect */
108         int *kib_nscheds;                /* # threads on each CPT */
109 } kib_tunables_t;
110
111 extern kib_tunables_t  kiblnd_tunables;
112
113 #define IBLND_MSG_QUEUE_SIZE_V1   8 /* V1 only : # messages/RDMAs in-flight */
114 #define IBLND_CREDIT_HIGHWATER_V1 7 /* V1 only : when eagerly to return credits */
115
116 #define IBLND_CREDITS_DEFAULT     8 /* default # of peer credits */
117 #define IBLND_CREDITS_MAX         ((typeof(((kib_msg_t *) 0)->ibm_credits)) - 1)  /* Max # of peer credits */
118
119 #define IBLND_MSG_QUEUE_SIZE(v)    ((v) == IBLND_MSG_VERSION_1 ? \
120                                      IBLND_MSG_QUEUE_SIZE_V1 :   \
121                                      *kiblnd_tunables.kib_peertxcredits) /* # messages/RDMAs in-flight */
122 #define IBLND_CREDITS_HIGHWATER(v) ((v) == IBLND_MSG_VERSION_1 ? \
123                                      IBLND_CREDIT_HIGHWATER_V1 : \
124                                      *kiblnd_tunables.kib_peercredits_hiw) /* when eagerly to return credits */
125
126 #define kiblnd_rdma_create_id(cb, dev, ps, qpt) rdma_create_id(cb, dev, ps, qpt)
127
128 static inline int
129 kiblnd_concurrent_sends_v1(void)
130 {
131         if (*kiblnd_tunables.kib_concurrent_sends > IBLND_MSG_QUEUE_SIZE_V1 * 2)
132                 return IBLND_MSG_QUEUE_SIZE_V1 * 2;
133
134         if (*kiblnd_tunables.kib_concurrent_sends < IBLND_MSG_QUEUE_SIZE_V1 / 2)
135                 return IBLND_MSG_QUEUE_SIZE_V1 / 2;
136
137         return *kiblnd_tunables.kib_concurrent_sends;
138 }
139
140 #define IBLND_CONCURRENT_SENDS(v)  ((v) == IBLND_MSG_VERSION_1 ? \
141                                      kiblnd_concurrent_sends_v1() : \
142                                      *kiblnd_tunables.kib_concurrent_sends)
143 /* 2 OOB shall suffice for 1 keepalive and 1 returning credits */
144 #define IBLND_OOB_CAPABLE(v)       ((v) != IBLND_MSG_VERSION_1)
145 #define IBLND_OOB_MSGS(v)          (IBLND_OOB_CAPABLE(v) ? 2 : 0)
146
147 #define IBLND_MSG_SIZE        (4<<10)            /* max size of queued messages (inc hdr) */
148 #define IBLND_MAX_RDMA_FRAGS     LNET_MAX_IOV      /* max # of fragments supported */
149 #define IBLND_CFG_RDMA_FRAGS       (*kiblnd_tunables.kib_map_on_demand != 0 ? \
150                                     *kiblnd_tunables.kib_map_on_demand :      \
151                                      IBLND_MAX_RDMA_FRAGS)  /* max # of fragments configured by user */
152 #define IBLND_RDMA_FRAGS(v)     ((v) == IBLND_MSG_VERSION_1 ? \
153                                      IBLND_MAX_RDMA_FRAGS : IBLND_CFG_RDMA_FRAGS)
154
155 /************************/
156 /* derived constants... */
157 /* Pools (shared by connections on each CPT) */
158 /* These pools can grow at runtime, so don't need give a very large value */
159 #define IBLND_TX_POOL                   256
160 #define IBLND_FMR_POOL                  256
161 #define IBLND_FMR_POOL_FLUSH            192
162
163 /* TX messages (shared by all connections) */
164 #define IBLND_TX_MSGS()     (*kiblnd_tunables.kib_ntx)
165
166 /* RX messages (per connection) */
167 #define IBLND_RX_MSGS(v)            (IBLND_MSG_QUEUE_SIZE(v) * 2 + IBLND_OOB_MSGS(v))
168 #define IBLND_RX_MSG_BYTES(v)       (IBLND_RX_MSGS(v) * IBLND_MSG_SIZE)
169 #define IBLND_RX_MSG_PAGES(v)      ((IBLND_RX_MSG_BYTES(v) + PAGE_SIZE - 1) / PAGE_SIZE)
170
171 /* WRs and CQEs (per connection) */
172 #define IBLND_RECV_WRS(v)           IBLND_RX_MSGS(v)
173 #define IBLND_SEND_WRS(v)         ((IBLND_RDMA_FRAGS(v) + 1) * IBLND_CONCURRENT_SENDS(v))
174 #define IBLND_CQ_ENTRIES(v)      (IBLND_RECV_WRS(v) + IBLND_SEND_WRS(v))
175
176 struct kib_hca_dev;
177
178 /* o2iblnd can run over aliased interface */
179 #ifdef IFALIASZ
180 #define KIB_IFNAME_SIZE       IFALIASZ
181 #else
182 #define KIB_IFNAME_SIZE       256
183 #endif
184
185 typedef struct {
186         struct list_head   ibd_list;            /* chain on kib_devs */
187         struct list_head   ibd_fail_list;       /* chain on kib_failed_devs */
188         __u32              ibd_ifip;            /* IPoIB interface IP */
189
190         /* IPoIB interface name */
191         char               ibd_ifname[KIB_IFNAME_SIZE];
192         int                ibd_nnets;           /* # nets extant */
193
194         unsigned long      ibd_next_failover;
195         int                ibd_failed_failover; /* # failover failures */
196         unsigned int       ibd_failover;        /* failover in progress */
197         unsigned int ibd_can_failover; /* IPoIB interface is a bonding master */
198         struct list_head   ibd_nets;
199         struct kib_hca_dev *ibd_hdev;
200 } kib_dev_t;
201
202 typedef struct kib_hca_dev {
203         struct rdma_cm_id  *ibh_cmid;           /* listener cmid */
204         struct ib_device   *ibh_ibdev;          /* IB device */
205         int                ibh_page_shift;      /* page shift of current HCA */
206         int                ibh_page_size;       /* page size of current HCA */
207         __u64              ibh_page_mask;       /* page mask of current HCA */
208         int                ibh_mr_shift;        /* bits shift of max MR size */
209         __u64              ibh_mr_size;         /* size of MR */
210         int                ibh_nmrs;            /* # of global MRs */
211         struct ib_mr       **ibh_mrs;           /* global MR */
212         struct ib_pd       *ibh_pd;             /* PD */
213         kib_dev_t          *ibh_dev;            /* owner */
214         atomic_t           ibh_ref;             /* refcount */
215 } kib_hca_dev_t;
216
217 /** # of seconds to keep pool alive */
218 #define IBLND_POOL_DEADLINE     300
219 /** # of seconds to retry if allocation failed */
220 #define IBLND_POOL_RETRY        1
221
222 typedef struct {
223         int                ibp_npages;          /* # pages */
224         struct page        *ibp_pages[0];       /* page array */
225 } kib_pages_t;
226
227 struct kib_pool;
228 struct kib_poolset;
229
230 typedef int  (*kib_ps_pool_create_t)(struct kib_poolset *ps,
231                                      int inc, struct kib_pool **pp_po);
232 typedef void (*kib_ps_pool_destroy_t)(struct kib_pool *po);
233 typedef void (*kib_ps_node_init_t)(struct kib_pool *po, struct list_head *node);
234 typedef void (*kib_ps_node_fini_t)(struct kib_pool *po, struct list_head *node);
235
236 struct kib_net;
237
238 #define IBLND_POOL_NAME_LEN     32
239
240 typedef struct kib_poolset {
241         spinlock_t            ps_lock;            /* serialize */
242         struct kib_net        *ps_net;            /* network it belongs to */
243         char                  ps_name[IBLND_POOL_NAME_LEN]; /* pool set name */
244         struct list_head      ps_pool_list;       /* list of pools */
245         struct list_head      ps_failed_pool_list;/* failed pool list */
246         unsigned long         ps_next_retry;      /* time stamp for retry if */
247                                                   /* failed to allocate */
248         int                   ps_increasing;      /* is allocating new pool */
249         int                   ps_pool_size;       /* new pool size */
250         int                   ps_cpt;             /* CPT id */
251
252         kib_ps_pool_create_t  ps_pool_create;     /* create a new pool */
253         kib_ps_pool_destroy_t ps_pool_destroy;    /* destroy a pool */
254         kib_ps_node_init_t    ps_node_init; /* initialize new allocated node */
255         kib_ps_node_fini_t    ps_node_fini;       /* finalize node */
256 } kib_poolset_t;
257
258 typedef struct kib_pool {
259         struct list_head      po_list;       /* chain on pool list */
260         struct list_head      po_free_list;  /* pre-allocated node */
261         kib_poolset_t         *po_owner;     /* pool_set of this pool */
262         unsigned long         po_deadline;   /* deadline of this pool */
263         int                   po_allocated;  /* # of elements in use */
264         int                   po_failed;     /* pool is created on failed HCA */
265         int                   po_size;       /* # of pre-allocated elements */
266 } kib_pool_t;
267
268 typedef struct {
269         kib_poolset_t         tps_poolset;        /* pool-set */
270         __u64                 tps_next_tx_cookie; /* cookie of TX */
271 } kib_tx_poolset_t;
272
273 typedef struct {
274         kib_pool_t            tpo_pool;           /* pool */
275         struct kib_hca_dev    *tpo_hdev;          /* device for this pool */
276         struct kib_tx         *tpo_tx_descs;      /* all the tx descriptors */
277         kib_pages_t           *tpo_tx_pages;      /* premapped tx msg pages */
278 } kib_tx_pool_t;
279
280 typedef struct {
281         spinlock_t            fps_lock;            /* serialize */
282         struct kib_net        *fps_net;            /* IB network */
283         struct list_head      fps_pool_list;       /* FMR pool list */
284         struct list_head      fps_failed_pool_list;/* FMR pool list */
285         __u64                 fps_version;         /* validity stamp */
286         int                   fps_cpt;             /* CPT id */
287         int                   fps_pool_size;
288         int                   fps_flush_trigger;
289         int                   fps_increasing;      /* is allocating new pool */
290         unsigned long         fps_next_retry;      /* time stamp for retry if*/
291                                                    /* failed to allocate */
292 } kib_fmr_poolset_t;
293
294 typedef struct {
295         struct list_head      fpo_list;            /* chain on pool list */
296         struct kib_hca_dev    *fpo_hdev;           /* device for this pool */
297         kib_fmr_poolset_t     *fpo_owner;          /* owner of this pool */
298         struct ib_fmr_pool    *fpo_fmr_pool;       /* IB FMR pool */
299         unsigned long         fpo_deadline;        /* deadline of this pool */
300         int                   fpo_failed;          /* fmr pool is failed */
301         int                   fpo_map_count;       /* # of mapped FMR */
302 } kib_fmr_pool_t;
303
304 typedef struct {
305         struct ib_pool_fmr    *fmr_pfmr;           /* IB pool fmr */
306         kib_fmr_pool_t        *fmr_pool;           /* pool of FMR */
307 } kib_fmr_t;
308
309 typedef struct kib_net {
310         struct list_head      ibn_list;       /* chain on kib_dev_t::ibd_nets */
311         __u64                 ibn_incarnation;/* my epoch */
312         int                   ibn_init;       /* initialisation state */
313         int                   ibn_shutdown;   /* shutting down? */
314
315         atomic_t              ibn_npeers;     /* # peers extant */
316         atomic_t              ibn_nconns;     /* # connections extant */
317
318         kib_tx_poolset_t      **ibn_tx_ps;    /* tx pool-set */
319         kib_fmr_poolset_t     **ibn_fmr_ps;   /* fmr pool-set */
320
321         kib_dev_t             *ibn_dev;       /* underlying IB device */
322 } kib_net_t;
323
324 #define KIB_THREAD_SHIFT                16
325 #define KIB_THREAD_ID(cpt, tid)         ((cpt) << KIB_THREAD_SHIFT | (tid))
326 #define KIB_THREAD_CPT(id)              ((id) >> KIB_THREAD_SHIFT)
327 #define KIB_THREAD_TID(id)              ((id) & ((1UL << KIB_THREAD_SHIFT) - 1))
328
329 struct kib_sched_info {
330         spinlock_t         ibs_lock;     /* serialise */
331         wait_queue_head_t  ibs_waitq;    /* schedulers sleep here */
332         struct list_head   ibs_conns;    /* conns to check for rx completions */
333         int                ibs_nthreads; /* number of scheduler threads */
334         int                ibs_nthreads_max; /* max allowed scheduler threads */
335         int                ibs_cpt;      /* CPT id */
336 };
337
338 typedef struct {
339         int               kib_init;           /* initialisation state */
340         int               kib_shutdown;       /* shut down? */
341         struct list_head  kib_devs;           /* IB devices extant */
342         struct list_head  kib_failed_devs;    /* list head of failed devices */
343         wait_queue_head_t kib_failover_waitq; /* schedulers sleep here */
344         atomic_t kib_nthreads;                /* # live threads */
345         rwlock_t kib_global_lock;    /* stabilize net/dev/peer/conn ops */
346         struct list_head *kib_peers; /* hash table of all my known peers */
347         int  kib_peer_hash_size;     /* size of kib_peers */
348         void *kib_connd; /* the connd task (serialisation assertions) */
349         struct list_head kib_connd_conns;   /* connections to setup/teardown */
350         struct list_head kib_connd_zombies; /* connections with zero refcount */
351         wait_queue_head_t kib_connd_waitq;  /* connection daemon sleeps here */
352         spinlock_t kib_connd_lock;          /* serialise */
353         struct ib_qp_attr kib_error_qpa;    /* QP->ERROR */
354         struct kib_sched_info **kib_scheds; /* percpt data for schedulers */
355 } kib_data_t;
356
357 #define IBLND_INIT_NOTHING 0
358 #define IBLND_INIT_DATA    1
359 #define IBLND_INIT_ALL     2
360
361 /************************************************************************
362  * IB Wire message format.
363  * These are sent in sender's byte order (i.e. receiver flips).
364  */
365
366 typedef struct kib_connparams {
367         __u16        ibcp_queue_depth;
368         __u16        ibcp_max_frags;
369         __u32        ibcp_max_msg_size;
370 } WIRE_ATTR kib_connparams_t;
371
372 typedef struct {
373         lnet_hdr_t   ibim_hdr;        /* portals header */
374         char         ibim_payload[0]; /* piggy-backed payload */
375 } WIRE_ATTR kib_immediate_msg_t;
376
377 typedef struct {
378         __u32        rf_nob;          /* # bytes this frag */
379         __u64        rf_addr;         /* CAVEAT EMPTOR: misaligned!! */
380 } WIRE_ATTR kib_rdma_frag_t;
381
382 typedef struct {
383         __u32           rd_key;       /* local/remote key */
384         __u32           rd_nfrags;    /* # fragments */
385         kib_rdma_frag_t rd_frags[0];  /* buffer frags */
386 } WIRE_ATTR kib_rdma_desc_t;
387
388 typedef struct {
389         lnet_hdr_t      ibprm_hdr;    /* portals header */
390         __u64           ibprm_cookie; /* opaque completion cookie */
391 } WIRE_ATTR kib_putreq_msg_t;
392
393 typedef struct {
394         __u64           ibpam_src_cookie; /* reflected completion cookie */
395         __u64           ibpam_dst_cookie; /* opaque completion cookie */
396         kib_rdma_desc_t ibpam_rd;         /* sender's sink buffer */
397 } WIRE_ATTR kib_putack_msg_t;
398
399 typedef struct {
400         lnet_hdr_t      ibgm_hdr;     /* portals header */
401         __u64           ibgm_cookie;  /* opaque completion cookie */
402         kib_rdma_desc_t ibgm_rd;      /* rdma descriptor */
403 } WIRE_ATTR kib_get_msg_t;
404
405 typedef struct {
406         __u64           ibcm_cookie;  /* opaque completion cookie */
407         __s32           ibcm_status;  /* < 0 failure: >= 0 length */
408 } WIRE_ATTR kib_completion_msg_t;
409
410 typedef struct {
411         /* First 2 fields fixed FOR ALL TIME */
412         __u32           ibm_magic;    /* I'm an ibnal message */
413         __u16           ibm_version;  /* this is my version number */
414
415         __u8            ibm_type;     /* msg type */
416         __u8            ibm_credits;  /* returned credits */
417         __u32           ibm_nob;      /* # bytes in whole message */
418         __u32           ibm_cksum;    /* checksum (0 == no checksum) */
419         __u64           ibm_srcnid;   /* sender's NID */
420         __u64           ibm_srcstamp; /* sender's incarnation */
421         __u64           ibm_dstnid;   /* destination's NID */
422         __u64           ibm_dststamp; /* destination's incarnation */
423
424         union {
425                 kib_connparams_t     connparams;
426                 kib_immediate_msg_t  immediate;
427                 kib_putreq_msg_t     putreq;
428                 kib_putack_msg_t     putack;
429                 kib_get_msg_t        get;
430                 kib_completion_msg_t completion;
431         } WIRE_ATTR ibm_u;
432 } WIRE_ATTR kib_msg_t;
433
434 #define IBLND_MSG_MAGIC     LNET_PROTO_IB_MAGIC /* unique magic */
435
436 #define IBLND_MSG_VERSION_1 0x11
437 #define IBLND_MSG_VERSION_2 0x12
438 #define IBLND_MSG_VERSION   IBLND_MSG_VERSION_2
439
440 #define IBLND_MSG_CONNREQ   0xc0        /* connection request */
441 #define IBLND_MSG_CONNACK   0xc1        /* connection acknowledge */
442 #define IBLND_MSG_NOOP      0xd0        /* nothing (just credits) */
443 #define IBLND_MSG_IMMEDIATE 0xd1        /* immediate */
444 #define IBLND_MSG_PUT_REQ   0xd2        /* putreq (src->sink) */
445 #define IBLND_MSG_PUT_NAK   0xd3        /* completion (sink->src) */
446 #define IBLND_MSG_PUT_ACK   0xd4        /* putack (sink->src) */
447 #define IBLND_MSG_PUT_DONE  0xd5        /* completion (src->sink) */
448 #define IBLND_MSG_GET_REQ   0xd6        /* getreq (sink->src) */
449 #define IBLND_MSG_GET_DONE  0xd7        /* completion (src->sink: all OK) */
450
451 typedef struct {
452         __u32            ibr_magic;       /* sender's magic */
453         __u16            ibr_version;     /* sender's version */
454         __u8             ibr_why;         /* reject reason */
455         __u8             ibr_padding;     /* padding */
456         __u64            ibr_incarnation; /* incarnation of peer */
457         kib_connparams_t ibr_cp;          /* connection parameters */
458 } WIRE_ATTR kib_rej_t;
459
460 /* connection rejection reasons */
461 #define IBLND_REJECT_CONN_RACE      1 /* You lost connection race */
462 #define IBLND_REJECT_NO_RESOURCES   2 /* Out of memory/conns etc */
463 #define IBLND_REJECT_FATAL          3 /* Anything else */
464 #define IBLND_REJECT_CONN_UNCOMPAT  4 /* incompatible version peer */
465 #define IBLND_REJECT_CONN_STALE     5 /* stale peer */
466 #define IBLND_REJECT_RDMA_FRAGS     6 /* Fatal: peer's rdma frags can't match */
467                                       /* mine */
468 #define IBLND_REJECT_MSG_QUEUE_SIZE 7 /* Fatal: peer's msg queue size can't */
469                                       /* match mine */
470
471 /***********************************************************************/
472
473 typedef struct kib_rx                         /* receive message */
474 {
475         struct list_head       rx_list;       /* queue for attention */
476         struct kib_conn        *rx_conn;      /* owning conn */
477         int                    rx_nob; /* # bytes received (-1 while posted) */
478         enum ib_wc_status      rx_status;     /* completion status */
479         kib_msg_t              *rx_msg;       /* message buffer (host vaddr) */
480         __u64                  rx_msgaddr;    /* message buffer (I/O addr) */
481         DECLARE_PCI_UNMAP_ADDR(rx_msgunmap);  /* for dma_unmap_single() */
482         struct ib_recv_wr      rx_wrq;        /* receive work item... */
483         struct ib_sge          rx_sge;        /* ...and its memory */
484 } kib_rx_t;
485
486 #define IBLND_POSTRX_DONT_POST    0 /* don't post */
487 #define IBLND_POSTRX_NO_CREDIT    1 /* post: no credits */
488 #define IBLND_POSTRX_PEER_CREDIT  2 /* post: give peer back 1 credit */
489 #define IBLND_POSTRX_RSRVD_CREDIT 3 /* post: give self back 1 reserved credit */
490
491 typedef struct kib_tx                         /* transmit message */
492 {
493         struct list_head      tx_list; /* queue on idle_txs ibc_tx_queue etc. */
494         kib_tx_pool_t         *tx_pool;       /* pool I'm from */
495         struct kib_conn       *tx_conn;       /* owning conn */
496         short                 tx_sending;     /* # tx callbacks outstanding */
497         short                 tx_queued;      /* queued for sending */
498         short                 tx_waiting;     /* waiting for peer */
499         int                   tx_status;      /* LNET completion status */
500         unsigned long         tx_deadline;    /* completion deadline */
501         __u64                 tx_cookie;      /* completion cookie */
502         lnet_msg_t *tx_lntmsg[2]; /* lnet msgs to finalize on completion */
503         kib_msg_t             *tx_msg;        /* message buffer (host vaddr) */
504         __u64                 tx_msgaddr;     /* message buffer (I/O addr) */
505         DECLARE_PCI_UNMAP_ADDR(tx_msgunmap);  /* for dma_unmap_single() */
506         int                   tx_nwrq;        /* # send work items */
507         struct ib_send_wr     *tx_wrq;        /* send work items... */
508         struct ib_sge         *tx_sge;        /* ...and their memory */
509         kib_rdma_desc_t       *tx_rd;         /* rdma descriptor */
510         int                   tx_nfrags;      /* # entries in... */
511         struct scatterlist    *tx_frags;      /* dma_map_sg descriptor */
512         __u64                 *tx_pages;      /* rdma phys page addrs */
513         kib_fmr_t             fmr;            /* FMR */
514         int                   tx_dmadir;      /* dma direction */
515 } kib_tx_t;
516
517 typedef struct kib_connvars {
518         kib_msg_t cv_msg; /* connection-in-progress variables */
519 } kib_connvars_t;
520
521 typedef struct kib_conn {
522         struct kib_sched_info *ibc_sched;      /* scheduler information */
523         struct kib_peer       *ibc_peer;       /* owning peer */
524         kib_hca_dev_t         *ibc_hdev;       /* HCA bound on */
525         struct list_head ibc_list;             /* stash on peer's conn list */
526         struct list_head      ibc_sched_list;  /* schedule for attention */
527         __u16                 ibc_version;     /* version of connection */
528         __u64                 ibc_incarnation; /* which instance of the peer */
529         atomic_t              ibc_refcount;    /* # users */
530         int                   ibc_state;       /* what's happening */
531         int                   ibc_nsends_posted; /* # uncompleted sends */
532         int                   ibc_noops_posted;  /* # uncompleted NOOPs */
533         int                   ibc_credits;     /* # credits I have */
534         int                   ibc_outstanding_credits; /* # credits to return */
535         int                   ibc_reserved_credits; /* # ACK/DONE msg credits */
536         int                   ibc_comms_error; /* set on comms error */
537         unsigned int          ibc_nrx:16;      /* receive buffers owned */
538         unsigned int          ibc_scheduled:1; /* scheduled for attention */
539         unsigned int          ibc_ready:1;     /* CQ callback fired */
540         unsigned long         ibc_last_send;   /* time of last send */
541         struct list_head      ibc_connd_list;  /* link chain for */
542                                                /* kiblnd_check_conns only */
543         struct list_head ibc_early_rxs; /* rxs completed before ESTABLISHED */
544         struct list_head ibc_tx_noops;         /* IBLND_MSG_NOOPs for */
545                                                /* IBLND_MSG_VERSION_1 */
546         struct list_head ibc_tx_queue;         /* sends that need a credit */
547         struct list_head ibc_tx_queue_nocred;  /* sends that don't need a */
548                                                /* credit */
549         struct list_head ibc_tx_queue_rsrvd;   /* sends that need to */
550                                                /* reserve an ACK/DONE msg */
551         struct list_head ibc_active_txs; /* active tx awaiting completion */
552         spinlock_t            ibc_lock;        /* serialise */
553         kib_rx_t              *ibc_rxs;        /* the rx descs */
554         kib_pages_t           *ibc_rx_pages;   /* premapped rx msg pages */
555
556         struct rdma_cm_id     *ibc_cmid;       /* CM id */
557         struct ib_cq          *ibc_cq;         /* completion queue */
558
559         kib_connvars_t        *ibc_connvars; /* in-progress connection state */
560 } kib_conn_t;
561
562 #define IBLND_CONN_INIT           0      /* being initialised */
563 #define IBLND_CONN_ACTIVE_CONNECT 1      /* active sending req */
564 #define IBLND_CONN_PASSIVE_WAIT   2      /* passive waiting for rtu */
565 #define IBLND_CONN_ESTABLISHED    3      /* connection established */
566 #define IBLND_CONN_CLOSING        4      /* being closed */
567 #define IBLND_CONN_DISCONNECTED   5      /* disconnected */
568
569 typedef struct kib_peer {
570         struct list_head ibp_list;        /* stash on global peer list */
571         lnet_nid_t       ibp_nid;         /* who's on the other end(s) */
572         lnet_ni_t        *ibp_ni;         /* LNet interface */
573         atomic_t         ibp_refcount;    /* # users */
574         struct list_head ibp_conns;       /* all active connections */
575         struct list_head ibp_tx_queue;    /* msgs waiting for a conn */
576         __u16            ibp_version;     /* version of peer */
577         __u64            ibp_incarnation; /* incarnation of peer */
578         int              ibp_connecting;  /* current active connection attempts
579                                            */
580         int              ibp_accepting;   /* current passive connection attempts
581                                            */
582         int              ibp_error;       /* errno on closing this peer */
583         unsigned long    ibp_last_alive;  /* when (in jiffies) I was last alive
584                                            */
585 } kib_peer_t;
586
587 extern kib_data_t kiblnd_data;
588
589 void kiblnd_hdev_destroy(kib_hca_dev_t *hdev);
590
591 static inline void
592 kiblnd_hdev_addref_locked(kib_hca_dev_t *hdev)
593 {
594         LASSERT(atomic_read(&hdev->ibh_ref) > 0);
595         atomic_inc(&hdev->ibh_ref);
596 }
597
598 static inline void
599 kiblnd_hdev_decref(kib_hca_dev_t *hdev)
600 {
601         LASSERT(atomic_read(&hdev->ibh_ref) > 0);
602         if (atomic_dec_and_test(&hdev->ibh_ref))
603                 kiblnd_hdev_destroy(hdev);
604 }
605
606 static inline int
607 kiblnd_dev_can_failover(kib_dev_t *dev)
608 {
609         if (!list_empty(&dev->ibd_fail_list)) /* already scheduled */
610                 return 0;
611
612         if (*kiblnd_tunables.kib_dev_failover == 0) /* disabled */
613                 return 0;
614
615         if (*kiblnd_tunables.kib_dev_failover > 1) /* force failover */
616                 return 1;
617
618         return dev->ibd_can_failover;
619 }
620
621 #define kiblnd_conn_addref(conn)                                \
622 do {                                                        \
623         CDEBUG(D_NET, "conn[%p] (%d)++\n",                    \
624                (conn), atomic_read(&(conn)->ibc_refcount)); \
625         atomic_inc(&(conn)->ibc_refcount);                \
626 } while (0)
627
628 #define kiblnd_conn_decref(conn)                                        \
629 do {                                                                    \
630         unsigned long flags;                                            \
631                                                                         \
632         CDEBUG(D_NET, "conn[%p] (%d)--\n",                              \
633                (conn), atomic_read(&(conn)->ibc_refcount));             \
634         LASSERT_ATOMIC_POS(&(conn)->ibc_refcount);                      \
635         if (atomic_dec_and_test(&(conn)->ibc_refcount)) {               \
636                 spin_lock_irqsave(&kiblnd_data.kib_connd_lock, flags);  \
637                 list_add_tail(&(conn)->ibc_list,                        \
638                                   &kiblnd_data.kib_connd_zombies);      \
639                 wake_up(&kiblnd_data.kib_connd_waitq);          \
640                 spin_unlock_irqrestore(&kiblnd_data.kib_connd_lock, flags);\
641         }                                                               \
642 } while (0)
643
644 #define kiblnd_peer_addref(peer)                                \
645 do {                                                        \
646         CDEBUG(D_NET, "peer[%p] -> %s (%d)++\n",                \
647                (peer), libcfs_nid2str((peer)->ibp_nid),  \
648                atomic_read(&(peer)->ibp_refcount));     \
649         atomic_inc(&(peer)->ibp_refcount);                \
650 } while (0)
651
652 #define kiblnd_peer_decref(peer)                                \
653 do {                                                        \
654         CDEBUG(D_NET, "peer[%p] -> %s (%d)--\n",                \
655                (peer), libcfs_nid2str((peer)->ibp_nid),  \
656                atomic_read(&(peer)->ibp_refcount));     \
657         LASSERT_ATOMIC_POS(&(peer)->ibp_refcount);            \
658         if (atomic_dec_and_test(&(peer)->ibp_refcount))     \
659                 kiblnd_destroy_peer(peer);                    \
660 } while (0)
661
662 static inline struct list_head *
663 kiblnd_nid2peerlist(lnet_nid_t nid)
664 {
665         unsigned int hash =
666                 ((unsigned int)nid) % kiblnd_data.kib_peer_hash_size;
667
668         return &kiblnd_data.kib_peers[hash];
669 }
670
671 static inline int
672 kiblnd_peer_active(kib_peer_t *peer)
673 {
674         /* Am I in the peer hash table? */
675         return !list_empty(&peer->ibp_list);
676 }
677
678 static inline kib_conn_t *
679 kiblnd_get_conn_locked(kib_peer_t *peer)
680 {
681         LASSERT(!list_empty(&peer->ibp_conns));
682
683         /* just return the first connection */
684         return list_entry(peer->ibp_conns.next, kib_conn_t, ibc_list);
685 }
686
687 static inline int
688 kiblnd_send_keepalive(kib_conn_t *conn)
689 {
690         return (*kiblnd_tunables.kib_keepalive > 0) &&
691                 cfs_time_after(jiffies, conn->ibc_last_send +
692                                *kiblnd_tunables.kib_keepalive*HZ);
693 }
694
695 static inline int
696 kiblnd_need_noop(kib_conn_t *conn)
697 {
698         LASSERT(conn->ibc_state >= IBLND_CONN_ESTABLISHED);
699
700         if (conn->ibc_outstanding_credits <
701             IBLND_CREDITS_HIGHWATER(conn->ibc_version) &&
702             !kiblnd_send_keepalive(conn))
703                 return 0; /* No need to send NOOP */
704
705         if (IBLND_OOB_CAPABLE(conn->ibc_version)) {
706                 if (!list_empty(&conn->ibc_tx_queue_nocred))
707                         return 0; /* NOOP can be piggybacked */
708
709                 /* No tx to piggyback NOOP onto or no credit to send a tx */
710                 return (list_empty(&conn->ibc_tx_queue) ||
711                         conn->ibc_credits == 0);
712         }
713
714         if (!list_empty(&conn->ibc_tx_noops) || /* NOOP already queued */
715             !list_empty(&conn->ibc_tx_queue_nocred) || /* piggyback NOOP */
716             conn->ibc_credits == 0)                 /* no credit */
717                 return 0;
718
719         if (conn->ibc_credits == 1 &&      /* last credit reserved for */
720             conn->ibc_outstanding_credits == 0) /* giving back credits */
721                 return 0;
722
723         /* No tx to piggyback NOOP onto or no credit to send a tx */
724         return (list_empty(&conn->ibc_tx_queue) || conn->ibc_credits == 1);
725 }
726
727 static inline void
728 kiblnd_abort_receives(kib_conn_t *conn)
729 {
730         ib_modify_qp(conn->ibc_cmid->qp,
731                      &kiblnd_data.kib_error_qpa, IB_QP_STATE);
732 }
733
734 static inline const char *
735 kiblnd_queue2str(kib_conn_t *conn, struct list_head *q)
736 {
737         if (q == &conn->ibc_tx_queue)
738                 return "tx_queue";
739
740         if (q == &conn->ibc_tx_queue_rsrvd)
741                 return "tx_queue_rsrvd";
742
743         if (q == &conn->ibc_tx_queue_nocred)
744                 return "tx_queue_nocred";
745
746         if (q == &conn->ibc_active_txs)
747                 return "active_txs";
748
749         LBUG();
750         return NULL;
751 }
752
753 /* CAVEAT EMPTOR: We rely on descriptor alignment to allow us to use the */
754 /* lowest bits of the work request id to stash the work item type. */
755
756 #define IBLND_WID_TX    0
757 #define IBLND_WID_RDMA  1
758 #define IBLND_WID_RX    2
759 #define IBLND_WID_MASK  3UL
760
761 static inline __u64
762 kiblnd_ptr2wreqid(void *ptr, int type)
763 {
764         unsigned long lptr = (unsigned long)ptr;
765
766         LASSERT((lptr & IBLND_WID_MASK) == 0);
767         LASSERT((type & ~IBLND_WID_MASK) == 0);
768         return (__u64)(lptr | type);
769 }
770
771 static inline void *
772 kiblnd_wreqid2ptr(__u64 wreqid)
773 {
774         return (void *)(((unsigned long)wreqid) & ~IBLND_WID_MASK);
775 }
776
777 static inline int
778 kiblnd_wreqid2type(__u64 wreqid)
779 {
780         return wreqid & IBLND_WID_MASK;
781 }
782
783 static inline void
784 kiblnd_set_conn_state(kib_conn_t *conn, int state)
785 {
786         conn->ibc_state = state;
787         mb();
788 }
789
790 static inline void
791 kiblnd_init_msg(kib_msg_t *msg, int type, int body_nob)
792 {
793         msg->ibm_type = type;
794         msg->ibm_nob  = offsetof(kib_msg_t, ibm_u) + body_nob;
795 }
796
797 static inline int
798 kiblnd_rd_size(kib_rdma_desc_t *rd)
799 {
800         int   i;
801         int   size;
802
803         for (i = size = 0; i < rd->rd_nfrags; i++)
804                 size += rd->rd_frags[i].rf_nob;
805
806         return size;
807 }
808
809 static inline __u64
810 kiblnd_rd_frag_addr(kib_rdma_desc_t *rd, int index)
811 {
812         return rd->rd_frags[index].rf_addr;
813 }
814
815 static inline __u32
816 kiblnd_rd_frag_size(kib_rdma_desc_t *rd, int index)
817 {
818         return rd->rd_frags[index].rf_nob;
819 }
820
821 static inline __u32
822 kiblnd_rd_frag_key(kib_rdma_desc_t *rd, int index)
823 {
824         return rd->rd_key;
825 }
826
827 static inline int
828 kiblnd_rd_consume_frag(kib_rdma_desc_t *rd, int index, __u32 nob)
829 {
830         if (nob < rd->rd_frags[index].rf_nob) {
831                 rd->rd_frags[index].rf_addr += nob;
832                 rd->rd_frags[index].rf_nob  -= nob;
833         } else {
834                 index++;
835         }
836
837         return index;
838 }
839
840 static inline int
841 kiblnd_rd_msg_size(kib_rdma_desc_t *rd, int msgtype, int n)
842 {
843         LASSERT(msgtype == IBLND_MSG_GET_REQ ||
844                 msgtype == IBLND_MSG_PUT_ACK);
845
846         return msgtype == IBLND_MSG_GET_REQ ?
847                offsetof(kib_get_msg_t, ibgm_rd.rd_frags[n]) :
848                offsetof(kib_putack_msg_t, ibpam_rd.rd_frags[n]);
849 }
850
851
852 static inline __u64
853 kiblnd_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
854 {
855         return ib_dma_mapping_error(dev, dma_addr);
856 }
857
858 static inline __u64 kiblnd_dma_map_single(struct ib_device *dev,
859                                           void *msg, size_t size,
860                                           enum dma_data_direction direction)
861 {
862         return ib_dma_map_single(dev, msg, size, direction);
863 }
864
865 static inline void kiblnd_dma_unmap_single(struct ib_device *dev,
866                                            __u64 addr, size_t size,
867                                           enum dma_data_direction direction)
868 {
869         ib_dma_unmap_single(dev, addr, size, direction);
870 }
871
872 #define KIBLND_UNMAP_ADDR_SET(p, m, a)  do {} while (0)
873 #define KIBLND_UNMAP_ADDR(p, m, a)      (a)
874
875 static inline int kiblnd_dma_map_sg(struct ib_device *dev,
876                                     struct scatterlist *sg, int nents,
877                                     enum dma_data_direction direction)
878 {
879         return ib_dma_map_sg(dev, sg, nents, direction);
880 }
881
882 static inline void kiblnd_dma_unmap_sg(struct ib_device *dev,
883                                        struct scatterlist *sg, int nents,
884                                        enum dma_data_direction direction)
885 {
886         ib_dma_unmap_sg(dev, sg, nents, direction);
887 }
888
889 static inline __u64 kiblnd_sg_dma_address(struct ib_device *dev,
890                                           struct scatterlist *sg)
891 {
892         return ib_sg_dma_address(dev, sg);
893 }
894
895 static inline unsigned int kiblnd_sg_dma_len(struct ib_device *dev,
896                                              struct scatterlist *sg)
897 {
898         return ib_sg_dma_len(dev, sg);
899 }
900
901 /* XXX We use KIBLND_CONN_PARAM(e) as writable buffer, it's not strictly */
902 /* right because OFED1.2 defines it as const, to use it we have to add */
903 /* (void *) cast to overcome "const" */
904
905 #define KIBLND_CONN_PARAM(e)     ((e)->param.conn.private_data)
906 #define KIBLND_CONN_PARAM_LEN(e) ((e)->param.conn.private_data_len)
907
908
909 struct ib_mr *kiblnd_find_rd_dma_mr(kib_hca_dev_t *hdev,
910                                     kib_rdma_desc_t *rd);
911 struct ib_mr *kiblnd_find_dma_mr(kib_hca_dev_t *hdev,
912                                  __u64 addr, __u64 size);
913 void kiblnd_map_rx_descs(kib_conn_t *conn);
914 void kiblnd_unmap_rx_descs(kib_conn_t *conn);
915 void kiblnd_pool_free_node(kib_pool_t *pool, struct list_head *node);
916 struct list_head *kiblnd_pool_alloc_node(kib_poolset_t *ps);
917
918 int  kiblnd_fmr_pool_map(kib_fmr_poolset_t *fps, __u64 *pages,
919                          int npages, __u64 iov, kib_fmr_t *fmr);
920 void kiblnd_fmr_pool_unmap(kib_fmr_t *fmr, int status);
921
922 int  kiblnd_startup(lnet_ni_t *ni);
923 void kiblnd_shutdown(lnet_ni_t *ni);
924 int  kiblnd_ctl(lnet_ni_t *ni, unsigned int cmd, void *arg);
925 void kiblnd_query(struct lnet_ni *ni, lnet_nid_t nid, unsigned long *when);
926
927 int  kiblnd_tunables_init(void);
928 void kiblnd_tunables_fini(void);
929
930 int  kiblnd_connd(void *arg);
931 int  kiblnd_scheduler(void *arg);
932 int  kiblnd_thread_start(int (*fn)(void *arg), void *arg, char *name);
933 int  kiblnd_failover_thread(void *arg);
934
935 int  kiblnd_alloc_pages(kib_pages_t **pp, int cpt, int npages);
936 void kiblnd_free_pages(kib_pages_t *p);
937
938 int  kiblnd_cm_callback(struct rdma_cm_id *cmid,
939                         struct rdma_cm_event *event);
940 int  kiblnd_translate_mtu(int value);
941
942 int  kiblnd_dev_failover(kib_dev_t *dev);
943 int  kiblnd_create_peer(lnet_ni_t *ni, kib_peer_t **peerp, lnet_nid_t nid);
944 void kiblnd_destroy_peer(kib_peer_t *peer);
945 void kiblnd_destroy_dev(kib_dev_t *dev);
946 void kiblnd_unlink_peer_locked(kib_peer_t *peer);
947 void kiblnd_peer_alive(kib_peer_t *peer);
948 kib_peer_t *kiblnd_find_peer_locked(lnet_nid_t nid);
949 void kiblnd_peer_connect_failed(kib_peer_t *peer, int active, int error);
950 int  kiblnd_close_stale_conns_locked(kib_peer_t *peer,
951                                       int version, __u64 incarnation);
952 int  kiblnd_close_peer_conns_locked(kib_peer_t *peer, int why);
953
954 void kiblnd_connreq_done(kib_conn_t *conn, int status);
955 kib_conn_t *kiblnd_create_conn(kib_peer_t *peer, struct rdma_cm_id *cmid,
956                                 int state, int version);
957 void kiblnd_destroy_conn(kib_conn_t *conn);
958 void kiblnd_close_conn(kib_conn_t *conn, int error);
959 void kiblnd_close_conn_locked(kib_conn_t *conn, int error);
960
961 int  kiblnd_init_rdma(kib_conn_t *conn, kib_tx_t *tx, int type,
962                        int nob, kib_rdma_desc_t *dstrd, __u64 dstcookie);
963
964 void kiblnd_launch_tx(lnet_ni_t *ni, kib_tx_t *tx, lnet_nid_t nid);
965 void kiblnd_queue_tx_locked(kib_tx_t *tx, kib_conn_t *conn);
966 void kiblnd_queue_tx(kib_tx_t *tx, kib_conn_t *conn);
967 void kiblnd_init_tx_msg(lnet_ni_t *ni, kib_tx_t *tx, int type, int body_nob);
968 void kiblnd_txlist_done(lnet_ni_t *ni, struct list_head *txlist,
969                          int status);
970 void kiblnd_check_sends (kib_conn_t *conn);
971
972 void kiblnd_qp_event(struct ib_event *event, void *arg);
973 void kiblnd_cq_event(struct ib_event *event, void *arg);
974 void kiblnd_cq_completion(struct ib_cq *cq, void *arg);
975
976 void kiblnd_pack_msg(lnet_ni_t *ni, kib_msg_t *msg, int version,
977                       int credits, lnet_nid_t dstnid, __u64 dststamp);
978 int  kiblnd_unpack_msg(kib_msg_t *msg, int nob);
979 int  kiblnd_post_rx(kib_rx_t *rx, int credit);
980
981 int  kiblnd_send(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg);
982 int  kiblnd_recv(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg, int delayed,
983                  unsigned int niov, struct kvec *iov, lnet_kiov_t *kiov,
984                  unsigned int offset, unsigned int mlen, unsigned int rlen);