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