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