Whamcloud - gitweb
LU-4360 Fix use after free in ksocknal_send
[fs/lustre-release.git] / lnet / klnds / mxlnd / mxlnd.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) 2012, Intel Corporation.
31  *
32  * Copyright (C) 2006 Myricom, Inc.
33  */
34 /*
35  * This file is part of Lustre, http://www.lustre.org/
36  * Lustre is a trademark of Sun Microsystems, Inc.
37  *
38  * lnet/klnds/mxlnd/mxlnd.h
39  *
40  * Author: Eric Barton <eric@bartonsoftware.com>
41  * Author: Scott Atchley <atchley at myri.com>
42  */
43
44 #include <linux/module.h>       /* module */
45 #include <linux/kernel.h>       /* module */
46 #include <linux/mm.h>
47 #include <linux/string.h>
48 #include <linux/stat.h>
49 #include <linux/errno.h>
50 #include <linux/unistd.h>
51 #include <linux/uio.h>
52 #include <linux/fs.h>
53
54 #include <asm/uaccess.h>
55 #include <asm/io.h>
56
57 #include <linux/init.h>         /* module */
58 #include <linux/fs.h>
59 #include <linux/file.h>
60 #include <linux/stat.h>
61 #include <linux/list.h>
62 #include <linux/kmod.h>
63 #include <linux/sysctl.h>
64 #include <linux/random.h>
65 #include <linux/utsname.h>
66 #include <linux/jiffies.h>      /* msecs_to_jiffies */
67 #include <asm/semaphore.h>
68
69 #include <net/sock.h>
70 #include <linux/in.h>
71
72 #include <asm/byteorder.h>      /* __LITTLE_ENDIAN */
73 #include <net/arp.h>            /* arp table */
74 #include <linux/netdevice.h>    /* get_device_by_name */
75 #include <linux/inetdevice.h>   /* neigh_lookup, etc. */
76 #include <linux/net.h>          /* sock_create_kern, kernel_connect, sock_release */
77
78 #define DEBUG_SUBSYSTEM S_LND
79
80 #include "libcfs/libcfs.h"
81 #include "lnet/lnet.h"
82 #include "lnet/lib-lnet.h"
83
84 #define MX_KERNEL 1
85 #include "mx_extensions.h"
86 #include "myriexpress.h"
87
88 #if LNET_MAX_IOV > MX_MAX_SEGMENTS
89     #error LNET_MAX_IOV is greater then MX_MAX_SEGMENTS
90 #endif
91
92 #define MXLND_MSG_MAGIC         0x4d583130              /* unique magic 'MX10' */
93 #define MXLND_MSG_VERSION       0x03
94
95 /* Using MX's 64 match bits
96  * We are using the match bits to specify message type and the cookie.  The
97  * highest four bits (60-63) are reserved for message type. Below we specify
98  * the types. We reserve the remaining combinations for future use.  The next 8
99  * bits (52-59) are reserved for returning a status code for failed GET_DATA
100  * (payload) messages. The last 52 bits are used for cookies. That should allow
101  * unique cookies for 4 KB messages at 10 Gbps line rate without rollover for
102  * about 8 years. That should be enough. */
103
104 #define MXLND_MSG_OFFSET        60      /* msg type offset */
105 #define MXLND_MSG_BITS          (64 - MXLND_MSG_OFFSET)
106 #define MXLND_MSG_MASK          (((1ULL<<MXLND_MSG_BITS) - 1) << MXLND_MSG_OFFSET)
107 #define MXLND_MSG_TYPE(x)       (((x) & MXLND_MSG_MASK) >> MXLND_MSG_OFFSET)
108
109 #define MXLND_ERROR_OFFSET      52      /* error value offset */
110 #define MXLND_ERROR_BITS        (MXLND_MSG_OFFSET - MXLND_ERROR_OFFSET)
111 #define MXLND_ERROR_MASK        (((1ULL<<MXLND_ERROR_BITS) - 1) << MXLND_ERROR_OFFSET)
112 #define MXLND_ERROR_VAL(x)      (((x) & MXLND_ERROR_MASK) >> MXLND_ERROR_OFFSET)
113
114 /* message types */
115 #define MXLND_MSG_ICON_REQ      0xb     /* mx_iconnect() before CONN_REQ */
116 #define MXLND_MSG_CONN_REQ      0xc     /* connection request */
117 #define MXLND_MSG_ICON_ACK      0x9     /* mx_iconnect() before CONN_ACK */
118 #define MXLND_MSG_CONN_ACK      0xa     /* connection request response */
119 #define MXLND_MSG_BYE           0xd     /* disconnect msg */
120 #define MXLND_MSG_EAGER         0xe     /* eager message */
121 #define MXLND_MSG_NOOP          0x1     /* no msg, return credits */
122 #define MXLND_MSG_PUT_REQ       0x2     /* put request src->sink */
123 #define MXLND_MSG_PUT_ACK       0x3     /* put ack     src<-sink */
124 #define MXLND_MSG_PUT_DATA      0x4     /* put payload src->sink */
125 #define MXLND_MSG_GET_REQ       0x5     /* get request sink->src */
126 #define MXLND_MSG_GET_DATA      0x6     /* get payload sink<-src */
127
128 /* when to roll-over the cookie value */
129 #define MXLND_MAX_COOKIE        ((1ULL << MXLND_ERROR_OFFSET) - 1)
130
131 /* defaults for configurable parameters */
132 #define MXLND_N_SCHED           1               /* # schedulers (mx_wait_any() threads) */
133 #define MXLND_NDAEMONS          3               /* connd, timeoutd, tx_queued */
134 #define MXLND_MX_BOARD          0               /* Use the first MX NIC if more than 1 avail */
135 #define MXLND_MX_EP_ID          0               /* MX endpoint ID */
136 #define MXLND_COMM_TIMEOUT      (20 * HZ)   /* timeout for send/recv (jiffies) */
137 #define MXLND_WAIT_TIMEOUT      HZ          /* timeout for wait (jiffies) */
138 #define MXLND_CONNECT_TIMEOUT   (5 * HZ)    /* timeout for connections (jiffies) */
139 #define MXLND_POLLING           1000            /* poll iterations before blocking */
140 #define MXLND_LOOKUP_COUNT      5               /* how many times to try to resolve MAC */
141 #define MXLND_MAX_PEERS         1024            /* number of nodes talking to me */
142
143 #define MXLND_MSG_SIZE          (4<<10)         /* pre-posted eager message size */
144 #define MXLND_MSG_QUEUE_DEPTH   8               /* default msg queue depth */
145 #define MXLND_NTX               256             /* default # of tx msg descriptors */
146
147 #define MXLND_HASH_BITS         6               /* the number of bits to hash over */
148 #define MXLND_HASH_SIZE         (1<<MXLND_HASH_BITS)
149                                                 /* number of peer lists for lookup.
150                                                    we hash over the last N bits of
151                                                    the IP address converted to an int. */
152 #define MXLND_HASH_MASK         (MXLND_HASH_SIZE - 1)
153                                                 /* ensure we use only the last N bits */
154
155 /* derived constants... */
156 /* TX messages (shared by all connections) */
157 #define MXLND_TX_MSGS()       (*kmxlnd_tunables.kmx_ntx)
158 #define MXLND_TX_MSG_BYTES()  (MXLND_TX_MSGS() * MXLND_MSG_SIZE)
159 #define MXLND_TX_MSG_PAGES()  ((MXLND_TX_MSG_BYTES() + PAGE_SIZE - 1)/PAGE_SIZE)
160
161 /* RX messages (per connection) */
162 #define MXLND_RX_MSGS()       (*kmxlnd_tunables.kmx_peercredits)
163 #define MXLND_RX_MSG_BYTES()  (MXLND_RX_MSGS() * MXLND_MSG_SIZE)
164 #define MXLND_RX_MSG_PAGES()  ((MXLND_RX_MSG_BYTES() + PAGE_SIZE - 1)/PAGE_SIZE)
165 #define MXLND_CREDIT_HIGHWATER() (*kmxlnd_tunables.kmx_peercredits - 2)
166                                                 /* when to send a noop to return credits */
167
168 /* debugging features */
169 #define MXLND_CKSUM             0       /* checksum kmx_msg_t */
170 #define MXLND_DEBUG             0       /* additional CDEBUG messages */
171
172 /* provide wrappers around LIBCFS_ALLOC/FREE to keep MXLND specific
173  * memory usage stats that include pages */
174
175 #define MXLND_ALLOC(x, size)                                    \
176         do {                                                    \
177                 spin_lock(&kmxlnd_data.kmx_mem_lock);           \
178                 kmxlnd_data.kmx_mem_used += size;               \
179                 spin_unlock(&kmxlnd_data.kmx_mem_lock);         \
180                 LIBCFS_ALLOC(x, size);                          \
181                 if (unlikely(x == NULL)) {                      \
182                         spin_lock(&kmxlnd_data.kmx_mem_lock);   \
183                         kmxlnd_data.kmx_mem_used -= size;       \
184                         spin_unlock(&kmxlnd_data.kmx_mem_lock); \
185                 }                                               \
186         } while (0)
187
188 #define MXLND_FREE(x, size)                                     \
189         do {                                                    \
190                 spin_lock(&kmxlnd_data.kmx_mem_lock);           \
191                 kmxlnd_data.kmx_mem_used -= size;               \
192                 spin_unlock(&kmxlnd_data.kmx_mem_lock);         \
193                 LIBCFS_FREE(x, size);                           \
194         } while (0)
195
196
197 typedef struct kmx_tunables
198 {
199         int     *kmx_n_waitd;           /* # completion threads */
200         int     *kmx_max_peers;         /* max # of potential peers */
201         int     *kmx_cksum;             /* checksum small msgs? */
202         int     *kmx_ntx;               /* total # of tx */
203         int     *kmx_credits;           /* concurrent sends to all peers */
204         int     *kmx_peercredits;       /* concurrent sends to 1 peer */
205         int     *kmx_board;             /* MX board (NIC) number */
206         int     *kmx_ep_id;             /* MX endpoint number */
207         char    **kmx_default_ipif;     /* IPoMX interface name */
208         int     *kmx_polling;           /* if 0, block. if > 0, poll this many
209                                            iterations before blocking */
210 } kmx_tunables_t;
211
212 typedef struct
213 {
214         int               mxg_npages;   /* # pages */
215         struct page      *mxg_pages[0];
216 } kmx_pages_t;
217
218 /* global interface state */
219 typedef struct kmx_data
220 {
221         int                 kmx_init;           /* initialization state */
222         atomic_t            kmx_shutdown;       /* shutting down? */
223         atomic_t            kmx_nthreads;       /* number of threads */
224         struct completion   *kmx_completions;   /* array of completion struct */
225         lnet_ni_t           *kmx_ni;            /* the LND instance */
226         u64                 kmx_incarnation;    /* my incarnation value */
227         long                kmx_mem_used;       /* memory used */
228         mx_endpoint_t       kmx_endpt;          /* the MX endpoint */
229         mx_endpoint_addr_t  kmx_epa;            /* the MX endpoint address */
230
231         rwlock_t            kmx_global_lock;    /* global lock */
232         spinlock_t          kmx_mem_lock;       /* memory accounting lock */
233
234         cfs_list_t          kmx_conn_reqs;      /* list of connection reqs */
235         spinlock_t          kmx_conn_lock;      /* connection list lock */
236         struct semaphore    kmx_conn_sem;       /* connection request list */
237         cfs_list_t          kmx_conn_zombies;   /* list of zombie connections */
238         cfs_list_t          kmx_orphan_msgs;    /* list of txs to cancel */
239
240                                                 /* list of all known peers */
241         cfs_list_t          kmx_peers[MXLND_HASH_SIZE];
242         atomic_t            kmx_npeers;         /* number of peers */
243
244         kmx_pages_t        *kmx_tx_pages;       /* tx msg pages */
245
246         struct kmx_ctx     *kmx_txs;            /* all tx descriptors */
247         cfs_list_t          kmx_tx_idle;        /* list of idle tx */
248         spinlock_t          kmx_tx_idle_lock;   /* lock for idle tx list */
249         s32                 kmx_tx_used;        /* txs in use */
250         u64                 kmx_tx_next_cookie; /* unique id for tx */
251         cfs_list_t          kmx_tx_queue;       /* generic send queue */
252         spinlock_t          kmx_tx_queue_lock;  /* lock for generic sends */
253         struct semaphore    kmx_tx_queue_sem;   /* semaphore for tx queue */
254 } kmx_data_t;
255
256 #define MXLND_INIT_NOTHING      0       /* in the beginning, there was nothing... */
257 #define MXLND_INIT_DATA         1       /* main data structures created */
258 #define MXLND_INIT_TXS          2       /* tx descriptors created */
259 #define MXLND_INIT_MX           3       /* initiate MX library, open endpoint, get NIC id */
260 #define MXLND_INIT_THREADS      4       /* waitd, timeoutd, tx_queued threads */
261 #define MXLND_INIT_ALL          5       /* startup completed */
262
263 /************************************************************************
264  * MXLND Wire message format.
265  * These are sent in sender's byte order (i.e. receiver flips).
266  */
267
268 typedef struct kmx_connreq_msg
269 {
270         u32             mxcrm_queue_depth;              /* per peer max messages in flight */
271         u32             mxcrm_eager_size;               /* size of preposted eager messages */
272 } WIRE_ATTR kmx_connreq_msg_t;
273
274 typedef struct kmx_eager_msg
275 {
276         lnet_hdr_t      mxem_hdr;                       /* lnet header */
277         char            mxem_payload[0];                /* piggy-backed payload */
278 } WIRE_ATTR kmx_eager_msg_t;
279
280 typedef struct kmx_putreq_msg
281 {
282         lnet_hdr_t      mxprm_hdr;                      /* lnet header */
283         u64             mxprm_cookie;                   /* opaque completion cookie */
284 } WIRE_ATTR kmx_putreq_msg_t;
285
286 typedef struct kmx_putack_msg
287 {
288         u64             mxpam_src_cookie;               /* reflected completion cookie */
289         u64             mxpam_dst_cookie;               /* opaque completion cookie */
290 } WIRE_ATTR kmx_putack_msg_t;
291
292 typedef struct kmx_getreq_msg
293 {
294         lnet_hdr_t      mxgrm_hdr;                      /* lnet header */
295         u64             mxgrm_cookie;                   /* opaque completion cookie */
296 } WIRE_ATTR kmx_getreq_msg_t;
297
298 typedef struct kmx_msg
299 {
300         /* First two fields fixed for all time */
301         u32             mxm_magic;                      /* MXLND message */
302         u16             mxm_version;                    /* version number */
303
304         u8              mxm_type;                       /* message type */
305         u8              mxm_credits;                    /* returned credits */
306         u32             mxm_nob;                        /* # of bytes in whole message */
307         u32             mxm_cksum;                      /* checksum (0 == no checksum) */
308         u64             mxm_srcnid;                     /* sender's NID */
309         u64             mxm_srcstamp;                   /* sender's incarnation */
310         u64             mxm_dstnid;                     /* destination's NID */
311         u64             mxm_dststamp;                   /* destination's incarnation */
312
313         union {
314                 kmx_connreq_msg_t       conn_req;
315                 kmx_eager_msg_t         eager;
316                 kmx_putreq_msg_t        put_req;
317                 kmx_putack_msg_t        put_ack;
318                 kmx_getreq_msg_t        get_req;
319         } WIRE_ATTR mxm_u;
320 } WIRE_ATTR kmx_msg_t;
321
322 /***********************************************************************/
323
324 enum kmx_req_type {
325         MXLND_REQ_TX    = 0,
326         MXLND_REQ_RX    = 1,
327 };
328
329 /* The life cycle of a request */
330 enum kmx_req_state {
331         MXLND_CTX_INIT       = 0,               /* just created */
332         MXLND_CTX_IDLE       = 1,               /* available for use */
333         MXLND_CTX_PREP       = 2,               /* getting ready for send/recv */
334         MXLND_CTX_PENDING    = 3,               /* mx_isend() or mx_irecv() called */
335         MXLND_CTX_COMPLETED  = 4,               /* cleaning up after completion or timeout */
336         MXLND_CTX_CANCELED   = 5,               /* timed out but still in ctx list */
337 };
338
339 /* Context Structure - generic tx/rx descriptor
340  * It represents the context (or state) of each send or receive request.
341  * In other LNDs, they have separate TX and RX descriptors and this replaces both.
342  *
343  * The txs live on the global kmx_txs array for cleanup. The rxs are managed
344  * per struct kmx_conn. We will move them between the rx/tx idle lists and the
345  * pending list which is monitored by mxlnd_timeoutd().
346  */
347 typedef struct kmx_ctx
348 {
349         enum kmx_req_type   mxc_type;           /* TX or RX */
350         u64                 mxc_incarnation;    /* store the peer's incarnation here
351                                                    to verify before changing flow
352                                                    control credits after completion */
353         unsigned long       mxc_deadline;       /* request time out in absolute jiffies */
354         enum kmx_req_state  mxc_state;          /* what is the state of the request? */
355         cfs_list_t          mxc_list;           /* place on rx/tx idle list, tx q, peer tx */
356         cfs_list_t          mxc_rx_list;        /* place on mxp_rx_posted list */
357
358         lnet_nid_t          mxc_nid;            /* dst's NID if peer is not known */
359         struct kmx_peer    *mxc_peer;           /* owning peer */
360         struct kmx_conn    *mxc_conn;           /* owning conn */
361         kmx_msg_t          *mxc_msg;            /* msg hdr mapped to mxc_page */
362         lnet_msg_t         *mxc_lntmsg[2];      /* lnet msgs to finalize */
363
364         u8                  mxc_msg_type;       /* what type of message is this? */
365         u64                 mxc_cookie;         /* completion cookie */
366         u64                 mxc_match;          /* MX match info */
367         mx_ksegment_t       mxc_seg;            /* local MX ksegment for non-DATA */
368         mx_ksegment_t      *mxc_seg_list;       /* MX ksegment array for DATA */
369         int                 mxc_nseg;           /* number of segments */
370         unsigned long       mxc_pin_type;       /* MX_PIN_PHYSICAL [| MX_PIN_FULLPAGES] */
371         u32                 mxc_nob;            /* number of bytes sent/received */
372         mx_request_t        mxc_mxreq;          /* MX request */
373         mx_status_t         mxc_status;         /* MX status */
374         u32                 mxc_errno;          /* errno for LNET */
375         u64                 mxc_get;            /* # of times returned from idle list */
376         u64                 mxc_put;            /* # of times returned from idle list */
377 } kmx_ctx_t;
378
379 #define MXLND_CONN_DISCONNECT  -2       /* conn is being destroyed - do not add txs */
380 #define MXLND_CONN_FAIL        -1       /* connect failed (bad handshake, unavail, etc.) */
381 #define MXLND_CONN_INIT         0       /* in the beginning, there was nothing... */
382 #define MXLND_CONN_REQ          1       /* a connection request message is needed */
383 #define MXLND_CONN_ACK          2       /* a connection ack is needed */
384 #define MXLND_CONN_WAIT         3       /* waiting for req or ack to complete */
385 #define MXLND_CONN_READY        4       /* ready to send */
386
387 /* store all data from an unexpected CONN_[REQ|ACK] receive */
388 typedef struct kmx_connparams
389 {
390         cfs_list_t              mxr_list;       /* list to hang on kmx_conn_reqs */
391         void                   *mxr_context;    /* context - unused - will hold net */
392         mx_endpoint_addr_t      mxr_epa;        /* the peer's epa */
393         u64                     mxr_match;      /* the CONN_REQ's match bits */
394         u32                     mxr_nob;        /* length of CONN_REQ message */
395         struct kmx_peer        *mxr_peer;       /* peer if known */
396         struct kmx_conn        *mxr_conn;       /* conn if known */
397         kmx_msg_t               mxr_msg;        /* the msg header & connreq_msg_t */
398 } kmx_connparams_t;
399
400 /* connection state - queues for queued and pending msgs */
401 typedef struct kmx_conn
402 {
403         struct kmx_peer    *mxk_peer;           /* owning peer */
404         cfs_list_t          mxk_list;           /* for placing on mxp_conns */
405         cfs_list_t          mxk_zombie;         /* for placing on zombies list */
406         u64                 mxk_incarnation;    /* connections's incarnation value */
407         u32                 mxk_sid;            /* peer's MX session id */
408         atomic_t        mxk_refcount;       /* reference counting */
409         int                 mxk_status;         /* can we send messages? MXLND_CONN_* */
410
411         mx_endpoint_addr_t  mxk_epa;            /* peer's endpoint address */
412
413         spinlock_t          mxk_lock;           /* lock */
414         unsigned long       mxk_timeout;        /* expiration of oldest pending tx/rx */
415         unsigned long       mxk_last_tx;        /* when last tx completed with success */
416         unsigned long       mxk_last_rx;        /* when last rx completed */
417
418         kmx_pages_t        *mxk_rx_pages;       /* rx msg pages */
419         kmx_ctx_t          *mxk_rxs;            /* the rx descriptors */
420         cfs_list_t          mxk_rx_idle;        /* list of idle rx */
421
422         int                 mxk_credits;        /* # of my credits for sending to peer */
423         int                 mxk_outstanding;    /* # of credits to return */
424
425         cfs_list_t          mxk_tx_credit_queue; /* send queue for peer */
426         cfs_list_t          mxk_tx_free_queue;  /* send queue for peer */
427         int                 mxk_ntx_msgs;       /* # of msgs on tx queues */
428         int                 mxk_ntx_data ;      /* # of DATA on tx queues */
429         int                 mxk_ntx_posted;     /* # of tx msgs in flight */
430         int                 mxk_data_posted;    /* # of tx data payloads in flight */
431
432         cfs_list_t          mxk_pending;        /* in flight rxs and txs */
433 } kmx_conn_t;
434
435 /* peer state */
436 typedef struct kmx_peer
437 {
438         cfs_list_t          mxp_list;           /* for placing on kmx_peers */
439         lnet_nid_t          mxp_nid;            /* peer's LNET NID */
440         lnet_ni_t          *mxp_ni;             /* LNET interface */
441         atomic_t        mxp_refcount;       /* reference counts */
442
443         cfs_list_t          mxp_conns;          /* list of connections */
444         kmx_conn_t         *mxp_conn;           /* current connection */
445         cfs_list_t          mxp_tx_queue;       /* msgs waiting for a conn */
446
447         u32                 mxp_board;          /* peer's board rank */
448         u32                 mxp_ep_id;          /* peer's MX endpoint ID */
449         u64                 mxp_nic_id;         /* remote's MX nic_id for mx_connect() */
450
451         unsigned long       mxp_reconnect_time; /* when to retry connect */
452         int                 mxp_incompatible;   /* incorrect conn_req values */
453 } kmx_peer_t;
454
455 extern kmx_data_t       kmxlnd_data;
456 extern kmx_tunables_t   kmxlnd_tunables;
457
458 /* required for the LNET API */
459 int  mxlnd_startup(lnet_ni_t *ni);
460 void mxlnd_shutdown(lnet_ni_t *ni);
461 int  mxlnd_ctl(lnet_ni_t *ni, unsigned int cmd, void *arg);
462 int  mxlnd_send(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg);
463 int  mxlnd_recv(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg, int delayed,
464                 unsigned int niov, struct iovec *iov, lnet_kiov_t *kiov,
465                 unsigned int offset, unsigned int mlen, unsigned int rlen);
466
467 /* in mxlnd.c */
468 extern void mxlnd_thread_stop(long id);
469 extern void mxlnd_ctx_init(kmx_ctx_t *ctx);
470 extern int  mxlnd_peer_alloc(kmx_peer_t **peerp, lnet_nid_t nid,
471                 u32 board, u32 ep_id, u64 nic_id);
472 extern int mxlnd_alloc_pages(kmx_pages_t **pp, int npages);
473 extern void mxlnd_free_pages(kmx_pages_t *p);
474
475 /* in mxlnd_cb.c */
476 void mxlnd_eager_recv(void *context, uint64_t match_value, uint32_t length);
477 extern mx_unexp_handler_action_t mxlnd_unexpected_recv(void *context,
478                 mx_endpoint_addr_t source, uint64_t match_value, uint32_t length,
479                 void *data_if_available);
480 extern void mxlnd_peer_free(kmx_peer_t *peer);
481 extern void mxlnd_conn_free_locked(kmx_conn_t *conn);
482 extern void mxlnd_conn_disconnect(kmx_conn_t *conn, int mx_dis, int send_bye);
483 extern int mxlnd_close_matching_conns(lnet_nid_t nid);
484 extern void mxlnd_sleep(unsigned long timeout);
485 extern int  mxlnd_tx_queued(void *arg);
486 extern void mxlnd_handle_rx_completion(kmx_ctx_t *rx);
487 extern int  mxlnd_check_sends(kmx_peer_t *peer);
488 extern int  mxlnd_tx_peer_queued(void *arg);
489 extern int  mxlnd_request_waitd(void *arg);
490 extern int  mxlnd_unex_recvd(void *arg);
491 extern int  mxlnd_timeoutd(void *arg);
492 extern int mxlnd_free_conn_zombies(void);
493 extern int  mxlnd_connd(void *arg);
494 extern int mxlnd_del_peer(lnet_nid_t nid);
495
496
497 /**
498  * mxlnd_nid_to_hash - hash the nid
499  * @nid - LNET ID
500  *
501  * Takes the u64 nid and XORs the lowest N bits by the next lowest N bits.
502  */
503 static inline int
504 mxlnd_nid_to_hash(lnet_nid_t nid)
505 {
506         return (nid & MXLND_HASH_MASK) ^
507                ((nid & (MXLND_HASH_MASK << MXLND_HASH_BITS)) >> MXLND_HASH_BITS);
508 }
509
510
511 #define mxlnd_peer_addref(peer)                                 \
512 do {                                                            \
513         LASSERT(peer != NULL);                                  \
514         LASSERT(atomic_read(&(peer)->mxp_refcount) > 0);        \
515         atomic_inc(&(peer)->mxp_refcount);                      \
516 } while (0)
517
518
519 #define mxlnd_peer_decref(peer)                                 \
520 do {                                                            \
521         LASSERT(atomic_read(&(peer)->mxp_refcount) > 0);        \
522         if (atomic_dec_and_test(&(peer)->mxp_refcount))         \
523                 mxlnd_peer_free(peer);                          \
524 } while (0)
525
526 #define mxlnd_conn_addref(conn)                                 \
527 do {                                                            \
528         LASSERT(conn != NULL);                                  \
529         LASSERT(atomic_read(&(conn)->mxk_refcount) > 0);        \
530         atomic_inc(&(conn)->mxk_refcount);                      \
531 } while (0)
532
533
534 #define mxlnd_conn_decref(conn)                                         \
535 do {                                                                    \
536         LASSERT(conn != NULL);                                          \
537         LASSERT(atomic_read(&(conn)->mxk_refcount) > 0);                \
538         if (atomic_dec_and_test(&(conn)->mxk_refcount)) {               \
539                 spin_lock(&kmxlnd_data.kmx_conn_lock);                  \
540                 LASSERT((conn)->mxk_status == MXLND_CONN_DISCONNECT);   \
541                 CDEBUG(D_NET, "adding conn %p to zombies\n", (conn));   \
542                 cfs_list_add_tail(&(conn)->mxk_zombie,                  \
543                                  &kmxlnd_data.kmx_conn_zombies);        \
544                 spin_unlock(&kmxlnd_data.kmx_conn_lock);                \
545                 up(&kmxlnd_data.kmx_conn_sem);                          \
546         }                                                               \
547 } while (0)
548
549 #define mxlnd_valid_msg_type(type)                              \
550 do {                                                            \
551         LASSERT((type) == MXLND_MSG_EAGER    ||                 \
552                 (type) == MXLND_MSG_ICON_REQ ||                 \
553                 (type) == MXLND_MSG_CONN_REQ ||                 \
554                 (type) == MXLND_MSG_ICON_ACK ||                 \
555                 (type) == MXLND_MSG_CONN_ACK ||                 \
556                 (type) == MXLND_MSG_BYE      ||                 \
557                 (type) == MXLND_MSG_NOOP     ||                 \
558                 (type) == MXLND_MSG_PUT_REQ  ||                 \
559                 (type) == MXLND_MSG_PUT_ACK  ||                 \
560                 (type) == MXLND_MSG_PUT_DATA ||                 \
561                 (type) == MXLND_MSG_GET_REQ  ||                 \
562                 (type) == MXLND_MSG_GET_DATA);                  \
563 } while (0)