lnet/include/lnet/lib-types.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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lnet/include/lnet/lib-types.h
  37  *
  38  * Types used by the library side routines that do not need to be
  39  * exposed to the user application
  40  */
  41
  42 #ifndef __LNET_LIB_TYPES_H__
  43 #define __LNET_LIB_TYPES_H__
  44
  45 #include <lnet/linux/lib-types.h>
  46
  47 #include <libcfs/libcfs.h>
  48 #include <libcfs/list.h>
  49 #include <lnet/types.h>
  50 #include <lnet/lnetctl.h>
  51
  52 #define WIRE_ATTR       __attribute__((packed))
  53
  54 /* Packed version of lnet_process_id_t to transfer via network */
  55 typedef struct {
  56         lnet_nid_t nid;
  57         lnet_pid_t pid;   /* node id / process id */
  58 } WIRE_ATTR lnet_process_id_packed_t;
  59
  60 /* The wire handle's interface cookie only matches one network interface in
  61  * one epoch (i.e. new cookie when the interface restarts or the node
  62  * reboots).  The object cookie only matches one object on that interface
  63  * during that object's lifetime (i.e. no cookie re-use). */
  64 typedef struct {
  65         __u64 wh_interface_cookie;
  66         __u64 wh_object_cookie;
  67 } WIRE_ATTR lnet_handle_wire_t;
  68
  69 typedef enum {
  70         LNET_MSG_ACK = 0,
  71         LNET_MSG_PUT,
  72         LNET_MSG_GET,
  73         LNET_MSG_REPLY,
  74         LNET_MSG_HELLO,
  75 } lnet_msg_type_t;
  76
  77 /* The variant fields of the portals message header are aligned on an 8
  78  * byte boundary in the message header.  Note that all types used in these
  79  * wire structs MUST be fixed size and the smaller types are placed at the
  80  * end. */
  81 typedef struct lnet_ack {
  82         lnet_handle_wire_t  dst_wmd;
  83         __u64               match_bits;
  84         __u32               mlength;
  85 } WIRE_ATTR lnet_ack_t;
  86
  87 typedef struct lnet_put {
  88         lnet_handle_wire_t  ack_wmd;
  89         __u64               match_bits;
  90         __u64               hdr_data;
  91         __u32               ptl_index;
  92         __u32               offset;
  93 } WIRE_ATTR lnet_put_t;
  94
  95 typedef struct lnet_get {
  96         lnet_handle_wire_t  return_wmd;
  97         __u64               match_bits;
  98         __u32               ptl_index;
  99         __u32               src_offset;
 100         __u32               sink_length;
 101 } WIRE_ATTR lnet_get_t;
 102
 103 typedef struct lnet_reply {
 104         lnet_handle_wire_t  dst_wmd;
 105 } WIRE_ATTR lnet_reply_t;
 106
 107 typedef struct lnet_hello {
 108         __u64              incarnation;
 109         __u32              type;
 110 } WIRE_ATTR lnet_hello_t;
 111
 112 typedef struct {
 113         lnet_nid_t          dest_nid;
 114         lnet_nid_t          src_nid;
 115         lnet_pid_t          dest_pid;
 116         lnet_pid_t          src_pid;
 117         __u32               type;               /* lnet_msg_type_t */
 118         __u32               payload_length;     /* payload data to follow */
 119         /*<------__u64 aligned------->*/
 120         union {
 121                 lnet_ack_t   ack;
 122                 lnet_put_t   put;
 123                 lnet_get_t   get;
 124                 lnet_reply_t reply;
 125                 lnet_hello_t hello;
 126         } msg;
 127 } WIRE_ATTR lnet_hdr_t;
 128
 129 /* A HELLO message contains a magic number and protocol version
 130  * code in the header's dest_nid, the peer's NID in the src_nid, and
 131  * LNET_MSG_HELLO in the type field.  All other common fields are zero
 132  * (including payload_size; i.e. no payload).
 133  * This is for use by byte-stream LNDs (e.g. TCP/IP) to check the peer is
 134  * running the same protocol and to find out its NID. These LNDs should
 135  * exchange HELLO messages when a connection is first established.  Individual
 136  * LNDs can put whatever else they fancy in lnet_hdr_t::msg.
 137  */
 138 typedef struct {
 139         __u32   magic;                          /* LNET_PROTO_TCP_MAGIC */
 140         __u16   version_major;                  /* increment on incompatible change */
 141         __u16   version_minor;                  /* increment on compatible change */
 142 } WIRE_ATTR lnet_magicversion_t;
 143
 144 /* PROTO MAGIC for LNDs */
 145 #define LNET_PROTO_IB_MAGIC                 0x0be91b91
 146 #define LNET_PROTO_RA_MAGIC                 0x0be91b92
 147 #define LNET_PROTO_QSW_MAGIC                0x0be91b93
 148 #define LNET_PROTO_GNI_MAGIC                0xb00fbabe /* ask Kim */
 149 #define LNET_PROTO_TCP_MAGIC                0xeebc0ded
 150 #define LNET_PROTO_PTL_MAGIC                0x50746C4E /* 'PtlN' unique magic */
 151 #define LNET_PROTO_MX_MAGIC                 0x4d583130 /* 'MX10'! */
 152 #define LNET_PROTO_ACCEPTOR_MAGIC           0xacce7100
 153 #define LNET_PROTO_PING_MAGIC               0x70696E67 /* 'ping' */
 154
 155 /* Placeholder for a future "unified" protocol across all LNDs */
 156 /* Current LNDs that receive a request with this magic will respond with a
 157  * "stub" reply using their current protocol */
 158 #define LNET_PROTO_MAGIC                    0x45726963 /* ! */
 159
 160
 161 #define LNET_PROTO_TCP_VERSION_MAJOR        1
 162 #define LNET_PROTO_TCP_VERSION_MINOR        0
 163
 164 /* Acceptor connection request */
 165 typedef struct {
 166         __u32       acr_magic;                  /* PTL_ACCEPTOR_PROTO_MAGIC */
 167         __u32       acr_version;                /* protocol version */
 168         __u64       acr_nid;                    /* target NID */
 169 } WIRE_ATTR lnet_acceptor_connreq_t;
 170
 171 #define LNET_PROTO_ACCEPTOR_VERSION       1
 172
 173 /* forward refs */
 174 struct lnet_libmd;
 175
 176 typedef struct lnet_msg {
 177         struct list_head        msg_activelist;
 178         struct list_head        msg_list;       /* Q for credits/MD */
 179
 180         lnet_process_id_t       msg_target;
 181         /* where is it from, it's only for building event */
 182         lnet_nid_t              msg_from;
 183         __u32                   msg_type;
 184
 185         /* commited for sending */
 186         unsigned int            msg_tx_committed:1;
 187         /* CPT # this message committed for sending */
 188         unsigned int            msg_tx_cpt:15;
 189         /* commited for receiving */
 190         unsigned int            msg_rx_committed:1;
 191         /* CPT # this message committed for receiving */
 192         unsigned int            msg_rx_cpt:15;
 193         /* queued for tx credit */
 194         unsigned int            msg_tx_delayed:1;
 195         /* queued for RX buffer */
 196         unsigned int            msg_rx_delayed:1;
 197         /* ready for pending on RX delay list */
 198         unsigned int            msg_rx_ready_delay:1;
 199
 200         unsigned int          msg_vmflush:1;      /* VM trying to free memory */
 201         unsigned int          msg_target_is_router:1; /* sending to a router */
 202         unsigned int          msg_routing:1;      /* being forwarded */
 203         unsigned int          msg_ack:1;          /* ack on finalize (PUT) */
 204         unsigned int          msg_sending:1;      /* outgoing message */
 205         unsigned int          msg_receiving:1;    /* being received */
 206         unsigned int          msg_txcredit:1;     /* taken an NI send credit */
 207         unsigned int          msg_peertxcredit:1; /* taken a peer send credit */
 208         unsigned int          msg_rtrcredit:1;    /* taken a globel router credit */
 209         unsigned int          msg_peerrtrcredit:1; /* taken a peer router credit */
 210         unsigned int          msg_onactivelist:1; /* on the activelist */
 211         unsigned int          msg_rdma_get:1;
 212
 213         struct lnet_peer     *msg_txpeer;         /* peer I'm sending to */
 214         struct lnet_peer     *msg_rxpeer;         /* peer I received from */
 215
 216         void                 *msg_private;
 217         struct lnet_libmd    *msg_md;
 218
 219         unsigned int          msg_len;
 220         unsigned int          msg_wanted;
 221         unsigned int          msg_offset;
 222         unsigned int          msg_niov;
 223         struct iovec         *msg_iov;
 224         lnet_kiov_t          *msg_kiov;
 225
 226         lnet_event_t          msg_ev;
 227         lnet_hdr_t            msg_hdr;
 228 } lnet_msg_t;
 229
 230
 231 typedef struct lnet_libhandle {
 232         struct list_head        lh_hash_chain;
 233         __u64                   lh_cookie;
 234 } lnet_libhandle_t;
 235
 236 #define lh_entry(ptr, type, member) \
 237         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
 238
 239 typedef struct lnet_eq {
 240         struct list_head        eq_list;
 241         lnet_libhandle_t        eq_lh;
 242         lnet_seq_t              eq_enq_seq;
 243         lnet_seq_t              eq_deq_seq;
 244         unsigned int            eq_size;
 245         lnet_eq_handler_t       eq_callback;
 246         lnet_event_t            *eq_events;
 247         int                     **eq_refs;      /* percpt refcount for EQ */
 248 } lnet_eq_t;
 249
 250 typedef struct lnet_me {
 251         struct list_head        me_list;
 252         lnet_libhandle_t        me_lh;
 253         lnet_process_id_t       me_match_id;
 254         unsigned int            me_portal;
 255         unsigned int            me_pos;         /* hash offset in mt_hash */
 256         __u64                   me_match_bits;
 257         __u64                   me_ignore_bits;
 258         lnet_unlink_t           me_unlink;
 259         struct lnet_libmd      *me_md;
 260 } lnet_me_t;
 261
 262 typedef struct lnet_libmd {
 263         struct list_head        md_list;
 264         lnet_libhandle_t        md_lh;
 265         lnet_me_t              *md_me;
 266         char                   *md_start;
 267         unsigned int            md_offset;
 268         unsigned int            md_length;
 269         unsigned int            md_max_size;
 270         int                     md_threshold;
 271         int                     md_refcount;
 272         unsigned int            md_options;
 273         unsigned int            md_flags;
 274         void                   *md_user_ptr;
 275         lnet_eq_t              *md_eq;
 276         unsigned int            md_niov;        /* # frags */
 277         union {
 278                 struct iovec    iov[LNET_MAX_IOV];
 279                 lnet_kiov_t     kiov[LNET_MAX_IOV];
 280         } md_iov;
 281 } lnet_libmd_t;
 282
 283 #define LNET_MD_FLAG_ZOMBIE      (1 << 0)
 284 #define LNET_MD_FLAG_AUTO_UNLINK (1 << 1)
 285 #define LNET_MD_FLAG_ABORTED     (1 << 2)
 286
 287 #ifdef LNET_USE_LIB_FREELIST
 288 typedef struct
 289 {
 290         /* single contiguous array of objects */
 291         void                   *fl_objs;
 292         /* the number of them */
 293         int                     fl_nobjs;
 294         /* the size (including overhead) of each of them */
 295         int                     fl_objsize;
 296         /* where they are enqueued */
 297         struct list_head        fl_list;
 298 } lnet_freelist_t;
 299
 300 typedef struct
 301 {
 302         struct list_head        fo_list;        /* enqueue on fl_list */
 303         void                   *fo_contents;    /* aligned contents */
 304 } lnet_freeobj_t;
 305 #endif
 306
 307 typedef struct {
 308         /* info about peers we are trying to fail */
 309         struct list_head        tp_list;        /* ln_test_peers */
 310         lnet_nid_t              tp_nid;         /* matching nid */
 311         unsigned int            tp_threshold;   /* # failures to simulate */
 312 } lnet_test_peer_t;
 313
 314 #define LNET_COOKIE_TYPE_MD    1
 315 #define LNET_COOKIE_TYPE_ME    2
 316 #define LNET_COOKIE_TYPE_EQ    3
 317 #define LNET_COOKIE_TYPE_BITS  2
 318 #define LNET_COOKIE_MASK        ((1ULL << LNET_COOKIE_TYPE_BITS) - 1ULL)
 319
 320 struct lnet_ni;                                  /* forward ref */
 321
 322 typedef struct lnet_lnd
 323 {
 324         /* fields managed by portals */
 325         struct list_head        lnd_list;       /* stash in the LND table */
 326         int                     lnd_refcount;   /* # active instances */
 327
 328         /* fields initialised by the LND */
 329         unsigned int          lnd_type;
 330
 331         int  (*lnd_startup) (struct lnet_ni *ni);
 332         void (*lnd_shutdown) (struct lnet_ni *ni);
 333         int  (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
 334
 335         /* In data movement APIs below, payload buffers are described as a set
 336          * of 'niov' fragments which are...
 337          * EITHER
 338          *    in virtual memory (struct iovec *iov != NULL)
 339          * OR
 340          *    in pages (kernel only: plt_kiov_t *kiov != NULL).
 341          * The LND may NOT overwrite these fragment descriptors.
 342          * An 'offset' and may specify a byte offset within the set of
 343          * fragments to start from
 344          */
 345
 346         /* Start sending a preformatted message.  'private' is NULL for PUT and
 347          * GET messages; otherwise this is a response to an incoming message
 348          * and 'private' is the 'private' passed to lnet_parse().  Return
 349          * non-zero for immediate failure, otherwise complete later with
 350          * lnet_finalize() */
 351         int (*lnd_send)(struct lnet_ni *ni, void *private, lnet_msg_t *msg);
 352
 353         /* Start receiving 'mlen' bytes of payload data, skipping the following
 354          * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
 355          * lnet_parse().  Return non-zero for immedaite failure, otherwise
 356          * complete later with lnet_finalize().  This also gives back a receive
 357          * credit if the LND does flow control. */
 358         int (*lnd_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
 359                         int delayed, unsigned int niov,
 360                         struct iovec *iov, lnet_kiov_t *kiov,
 361                         unsigned int offset, unsigned int mlen, unsigned int rlen);
 362
 363         /* lnet_parse() has had to delay processing of this message
 364          * (e.g. waiting for a forwarding buffer or send credits).  Give the
 365          * LND a chance to free urgently needed resources.  If called, return 0
 366          * for success and do NOT give back a receive credit; that has to wait
 367          * until lnd_recv() gets called.  On failure return < 0 and
 368          * release resources; lnd_recv() will not be called. */
 369         int (*lnd_eager_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
 370                               void **new_privatep);
 371
 372         /* notification of peer health */
 373         void (*lnd_notify)(struct lnet_ni *ni, lnet_nid_t peer, int alive);
 374
 375         /* query of peer aliveness */
 376         void (*lnd_query)(struct lnet_ni *ni, lnet_nid_t peer, cfs_time_t *when);
 377
 378 #if defined(__KERNEL__) || defined(HAVE_LIBPTHREAD)
 379         /* accept a new connection */
 380         int (*lnd_accept)(struct lnet_ni *ni, cfs_socket_t *sock);
 381 #endif
 382
 383 #ifndef __KERNEL__
 384         /* wait for something to happen */
 385         void (*lnd_wait)(struct lnet_ni *ni, int milliseconds);
 386
 387         /* ensure non-RDMA messages can be received outside liblustre */
 388         int (*lnd_setasync)(struct lnet_ni *ni, lnet_process_id_t id, int nasync);
 389 #endif
 390 } lnd_t;
 391
 392 #define LNET_NI_STATUS_UP      0x15aac0de
 393 #define LNET_NI_STATUS_DOWN    0xdeadface
 394 #define LNET_NI_STATUS_INVALID 0x00000000
 395 typedef struct {
 396         lnet_nid_t ns_nid;
 397         __u32      ns_status;
 398         __u32      ns_unused;
 399 } WIRE_ATTR lnet_ni_status_t;
 400
 401 struct lnet_tx_queue {
 402         int                     tq_credits;     /* # tx credits free */
 403         int                     tq_credits_min; /* lowest it's been */
 404         int                     tq_credits_max; /* total # tx credits */
 405         struct list_head        tq_delayed;     /* delayed TXs */
 406 };
 407
 408 #define LNET_MAX_INTERFACES     16
 409
 410 typedef struct lnet_ni {
 411 #ifdef __KERNEL__
 412         spinlock_t              ni_lock;
 413 #else
 414 # ifndef HAVE_LIBPTHREAD
 415         int                     ni_lock;
 416 # else
 417         pthread_mutex_t         ni_lock;
 418 # endif
 419 #endif
 420         struct list_head        ni_list;        /* chain on ln_nis */
 421         struct list_head        ni_cptlist;     /* chain on ln_nis_cpt */
 422         int                     ni_maxtxcredits; /* # tx credits  */
 423         /* # per-peer send credits */
 424         int                     ni_peertxcredits;
 425         /* # per-peer router buffer credits */
 426         int                     ni_peerrtrcredits;
 427         /* seconds to consider peer dead */
 428         int                     ni_peertimeout;
 429         int                     ni_ncpts;       /* number of CPTs */
 430         __u32                   *ni_cpts;       /* bond NI on some CPTs */
 431         lnet_nid_t              ni_nid;         /* interface's NID */
 432         void                    *ni_data;       /* instance-specific data */
 433         lnd_t                   *ni_lnd;        /* procedural interface */
 434         struct lnet_tx_queue    **ni_tx_queues; /* percpt TX queues */
 435         int                     **ni_refs;      /* percpt reference count */
 436         long                    ni_last_alive;  /* when I was last alive */
 437         lnet_ni_status_t        *ni_status;     /* my health status */
 438         /* equivalent interfaces to use */
 439         char                    *ni_interfaces[LNET_MAX_INTERFACES];
 440 } lnet_ni_t;
 441
 442 #define LNET_PROTO_PING_MATCHBITS       0x8000000000000000LL
 443
 444 /* NB: value of these features equal to LNET_PROTO_PING_VERSION_x
 445  * of old LNet, so there shouldn't be any compatibility issue */
 446 #define LNET_PING_FEAT_INVAL            (0)             /* no feature */
 447 #define LNET_PING_FEAT_BASE             (1 << 0)        /* just a ping */
 448 #define LNET_PING_FEAT_NI_STATUS        (1 << 1)        /* return NI status */
 449 #define LNET_PING_FEAT_RTE_DISABLED     (1 << 2)        /* Routing enabled */
 450
 451 #define LNET_PING_FEAT_MASK             (LNET_PING_FEAT_BASE | \
 452                                          LNET_PING_FEAT_NI_STATUS)
 453
 454 typedef struct {
 455         __u32                   pi_magic;
 456         __u32                   pi_features;
 457         lnet_pid_t              pi_pid;
 458         __u32                   pi_nnis;
 459         lnet_ni_status_t        pi_ni[0];
 460 } WIRE_ATTR lnet_ping_info_t;
 461
 462 /* router checker data, per router */
 463 #define LNET_MAX_RTR_NIS   16
 464 #define LNET_PINGINFO_SIZE offsetof(lnet_ping_info_t, pi_ni[LNET_MAX_RTR_NIS])
 465 typedef struct {
 466         /* chain on the_lnet.ln_zombie_rcd or ln_deathrow_rcd */
 467         struct list_head        rcd_list;
 468         lnet_handle_md_t        rcd_mdh;        /* ping buffer MD */
 469         struct lnet_peer        *rcd_gateway;   /* reference to gateway */
 470         lnet_ping_info_t        *rcd_pinginfo;  /* ping buffer */
 471 } lnet_rc_data_t;
 472
 473 typedef struct lnet_peer {
 474         /* chain on peer hash */
 475         struct list_head        lp_hashlist;
 476         /* messages blocking for tx credits */
 477         struct list_head        lp_txq;
 478         /* messages blocking for router credits */
 479         struct list_head        lp_rtrq;
 480         /* chain on router list */
 481         struct list_head        lp_rtr_list;
 482         /* # tx credits available */
 483         int                     lp_txcredits;
 484         /* low water mark */
 485         int                     lp_mintxcredits;
 486         /* # router credits */
 487         int                     lp_rtrcredits;
 488         /* low water mark */
 489         int                     lp_minrtrcredits;
 490         /* alive/dead? */
 491         unsigned int            lp_alive:1;
 492         /* notification outstanding? */
 493         unsigned int            lp_notify:1;
 494         /* outstanding notification for LND? */
 495         unsigned int            lp_notifylnd:1;
 496         /* some thread is handling notification */
 497         unsigned int            lp_notifying:1;
 498         /* SEND event outstanding from ping */
 499         unsigned int            lp_ping_notsent;
 500         /* # times router went dead<->alive */
 501         int                     lp_alive_count;
 502         /* bytes queued for sending */
 503         long                    lp_txqnob;
 504         /* time of last aliveness news */
 505         cfs_time_t              lp_timestamp;
 506         /* time of last ping attempt */
 507         cfs_time_t              lp_ping_timestamp;
 508         /* != 0 if ping reply expected */
 509         cfs_time_t              lp_ping_deadline;
 510         /* when I was last alive */
 511         cfs_time_t              lp_last_alive;
 512         /* when lp_ni was queried last time */
 513         cfs_time_t              lp_last_query;
 514         /* interface peer is on */
 515         lnet_ni_t               *lp_ni;
 516         lnet_nid_t              lp_nid;         /* peer's NID */
 517         int                     lp_refcount;    /* # refs */
 518         int                     lp_cpt;         /* CPT this peer attached on */
 519         /* # refs from lnet_route_t::lr_gateway */
 520         int                     lp_rtr_refcount;
 521         /* returned RC ping features */
 522         unsigned int            lp_ping_feats;
 523         struct list_head        lp_routes;      /* routers on this peer */
 524         lnet_rc_data_t          *lp_rcd;        /* router checker state */
 525 } lnet_peer_t;
 526
 527 /* peer hash size */
 528 #define LNET_PEER_HASH_BITS     9
 529 #define LNET_PEER_HASH_SIZE     (1 << LNET_PEER_HASH_BITS)
 530
 531 /* peer hash table */
 532 struct lnet_peer_table {
 533         int                     pt_version;     /* /proc validity stamp */
 534         int                     pt_number;      /* # peers extant */
 535         int                     pt_zombies;     /* # zombies to go to deathrow
 536                                                  * (and not there yet) */
 537         struct list_head        pt_deathrow;    /* zombie peers */
 538         struct list_head        *pt_hash;       /* NID->peer hash */
 539 };
 540
 541 /* peer aliveness is enabled only on routers for peers in a network where the
 542  * lnet_ni_t::ni_peertimeout has been set to a positive value */
 543 #define lnet_peer_aliveness_enabled(lp) (the_lnet.ln_routing != 0 && \
 544                                          (lp)->lp_ni->ni_peertimeout > 0)
 545
 546 typedef struct {
 547         struct list_head        lr_list;        /* chain on net */
 548         struct list_head        lr_gwlist;      /* chain on gateway */
 549         lnet_peer_t             *lr_gateway;    /* router node */
 550         __u32                   lr_net;         /* remote network number */
 551         int                     lr_seq;         /* sequence for round-robin */
 552         unsigned int            lr_downis;      /* number of down NIs */
 553         unsigned int            lr_hops;        /* how far I am */
 554         unsigned int            lr_priority;    /* route priority */
 555 } lnet_route_t;
 556
 557 #define LNET_REMOTE_NETS_HASH_DEFAULT   (1U << 7)
 558 #define LNET_REMOTE_NETS_HASH_MAX       (1U << 16)
 559 #define LNET_REMOTE_NETS_HASH_SIZE      (1 << the_lnet.ln_remote_nets_hbits)
 560
 561 typedef struct {
 562         /* chain on ln_remote_nets_hash */
 563         struct list_head        lrn_list;
 564         /* routes to me */
 565         struct list_head        lrn_routes;
 566         /* my net number */
 567         __u32                   lrn_net;
 568 } lnet_remotenet_t;
 569
 570 /** lnet message has credit and can be submitted to lnd for send/receive */
 571 #define LNET_CREDIT_OK          0
 572 /** lnet message is waiting for credit */
 573 #define LNET_CREDIT_WAIT        1
 574
 575 typedef struct {
 576         /* my free buffer pool */
 577         struct list_head        rbp_bufs;
 578         /* messages blocking for a buffer */
 579         struct list_head        rbp_msgs;
 580         /* # pages in each buffer */
 581         int                     rbp_npages;
 582         /* # buffers */
 583         int                     rbp_nbuffers;
 584         /* # free buffers / blocked messages */
 585         int                     rbp_credits;
 586         /* low water mark */
 587         int                     rbp_mincredits;
 588 } lnet_rtrbufpool_t;
 589
 590 typedef struct {
 591         struct list_head         rb_list;       /* chain on rbp_bufs */
 592         lnet_rtrbufpool_t       *rb_pool;       /* owning pool */
 593         lnet_kiov_t              rb_kiov[0];    /* the buffer space */
 594 } lnet_rtrbuf_t;
 595
 596 typedef struct lnet_counters {
 597         __u32 msgs_alloc;
 598         __u32 msgs_max;
 599         __u32 errors;
 600         __u32 send_count;
 601         __u32 recv_count;
 602         __u32 route_count;
 603         __u32 drop_count;
 604         __u64 send_length;
 605         __u64 recv_length;
 606         __u64 route_length;
 607         __u64 drop_length;
 608 } WIRE_ATTR lnet_counters_t;
 609
 610 #define LNET_PEER_HASHSIZE   503                /* prime! */
 611
 612 #define LNET_TINY_BUF_IDX       0
 613 #define LNET_SMALL_BUF_IDX      1
 614 #define LNET_LARGE_BUF_IDX      2
 615
 616 /* # different router buffer pools */
 617 #define LNET_NRBPOOLS           (LNET_LARGE_BUF_IDX + 1)
 618
 619 enum {
 620         /* Didn't match anything */
 621         LNET_MATCHMD_NONE       = (1 << 0),
 622         /* Matched OK */
 623         LNET_MATCHMD_OK         = (1 << 1),
 624         /* Must be discarded */
 625         LNET_MATCHMD_DROP       = (1 << 2),
 626         /* match and buffer is exhausted */
 627         LNET_MATCHMD_EXHAUSTED  = (1 << 3),
 628         /* match or drop */
 629         LNET_MATCHMD_FINISH     = (LNET_MATCHMD_OK | LNET_MATCHMD_DROP),
 630 };
 631
 632 /* Options for lnet_portal_t::ptl_options */
 633 #define LNET_PTL_LAZY               (1 << 0)
 634 #define LNET_PTL_MATCH_UNIQUE       (1 << 1)    /* unique match, for RDMA */
 635 #define LNET_PTL_MATCH_WILDCARD     (1 << 2)    /* wildcard match, request portal */
 636
 637 /* parameter for matching operations (GET, PUT) */
 638 struct lnet_match_info {
 639         __u64                   mi_mbits;
 640         lnet_process_id_t       mi_id;
 641         unsigned int            mi_opc;
 642         unsigned int            mi_portal;
 643         unsigned int            mi_rlength;
 644         unsigned int            mi_roffset;
 645 };
 646
 647 /* ME hash of RDMA portal */
 648 #define LNET_MT_HASH_BITS               8
 649 #define LNET_MT_HASH_SIZE               (1 << LNET_MT_HASH_BITS)
 650 #define LNET_MT_HASH_MASK               (LNET_MT_HASH_SIZE - 1)
 651 /* we allocate (LNET_MT_HASH_SIZE + 1) entries for lnet_match_table::mt_hash,
 652  * the last entry is reserved for MEs with ignore-bits */
 653 #define LNET_MT_HASH_IGNORE             LNET_MT_HASH_SIZE
 654 /* __u64 has 2^6 bits, so need 2^(LNET_MT_HASH_BITS - LNET_MT_BITS_U64) which
 655  * is 4 __u64s as bit-map, and add an extra __u64 (only use one bit) for the
 656  * ME-list with ignore-bits, which is mtable::mt_hash[LNET_MT_HASH_IGNORE] */
 657 #define LNET_MT_BITS_U64                6       /* 2^6 bits */
 658 #define LNET_MT_EXHAUSTED_BITS          (LNET_MT_HASH_BITS - LNET_MT_BITS_U64)
 659 #define LNET_MT_EXHAUSTED_BMAP          ((1 << LNET_MT_EXHAUSTED_BITS) + 1)
 660
 661 /* portal match table */
 662 struct lnet_match_table {
 663         /* reserved for upcoming patches, CPU partition ID */
 664         unsigned int            mt_cpt;
 665         unsigned int            mt_portal;      /* portal index */
 666         /* match table is set as "enabled" if there's non-exhausted MD
 667          * attached on mt_mhash, it's only valide for wildcard portal */
 668         unsigned int            mt_enabled;
 669         /* bitmap to flag whether MEs on mt_hash are exhausted or not */
 670         __u64                   mt_exhausted[LNET_MT_EXHAUSTED_BMAP];
 671         struct list_head        *mt_mhash;      /* matching hash */
 672 };
 673
 674 /* these are only useful for wildcard portal */
 675 /* Turn off message rotor for wildcard portals */
 676 #define LNET_PTL_ROTOR_OFF      0
 677 /* round-robin dispatch all PUT messages for wildcard portals */
 678 #define LNET_PTL_ROTOR_ON       1
 679 /* round-robin dispatch routed PUT message for wildcard portals */
 680 #define LNET_PTL_ROTOR_RR_RT    2
 681 /* dispatch routed PUT message by hashing source NID for wildcard portals */
 682 #define LNET_PTL_ROTOR_HASH_RT  3
 683
 684 typedef struct lnet_portal {
 685 #ifdef __KERNEL__
 686         spinlock_t              ptl_lock;
 687 #else
 688 # ifndef HAVE_LIBPTHREAD
 689         int                     ptl_lock;
 690 # else
 691         pthread_mutex_t         ptl_lock;
 692 # endif
 693 #endif
 694         unsigned int            ptl_index;      /* portal ID, reserved */
 695         /* flags on this portal: lazy, unique... */
 696         unsigned int            ptl_options;
 697         /* list of messags which are stealing buffer */
 698         struct list_head        ptl_msg_stealing;
 699         /* messages blocking for MD */
 700         struct list_head        ptl_msg_delayed;
 701         /* Match table for each CPT */
 702         struct lnet_match_table **ptl_mtables;
 703         /* spread rotor of incoming "PUT" */
 704         unsigned int            ptl_rotor;
 705         /* # active entries for this portal */
 706         int                     ptl_mt_nmaps;
 707         /* array of active entries' cpu-partition-id */
 708         int                     ptl_mt_maps[0];
 709 } lnet_portal_t;
 710
 711 #define LNET_LH_HASH_BITS       12
 712 #define LNET_LH_HASH_SIZE       (1ULL << LNET_LH_HASH_BITS)
 713 #define LNET_LH_HASH_MASK       (LNET_LH_HASH_SIZE - 1)
 714
 715 /* resource container (ME, MD, EQ) */
 716 struct lnet_res_container {
 717         unsigned int            rec_type;       /* container type */
 718         __u64                   rec_lh_cookie;  /* cookie generator */
 719         struct list_head        rec_active;     /* active resource list */
 720         struct list_head        *rec_lh_hash;   /* handle hash */
 721 #ifdef LNET_USE_LIB_FREELIST
 722         lnet_freelist_t         rec_freelist;   /* freelist for resources */
 723 #endif
 724 };
 725
 726 /* message container */
 727 struct lnet_msg_container {
 728         int                     msc_init;       /* initialized or not */
 729         /* max # threads finalizing */
 730         int                     msc_nfinalizers;
 731         /* msgs waiting to complete finalizing */
 732         struct list_head        msc_finalizing;
 733         struct list_head        msc_active;     /* active message list */
 734         /* threads doing finalization */
 735         void                    **msc_finalizers;
 736 #ifdef LNET_USE_LIB_FREELIST
 737         lnet_freelist_t         msc_freelist;   /* freelist for messages */
 738 #endif
 739 };
 740
 741 /* Router Checker states */
 742 #define LNET_RC_STATE_SHUTDOWN          0       /* not started */
 743 #define LNET_RC_STATE_RUNNING           1       /* started up OK */
 744 #define LNET_RC_STATE_STOPPING          2       /* telling thread to stop */
 745
 746 typedef struct
 747 {
 748         /* CPU partition table of LNet */
 749         struct cfs_cpt_table            *ln_cpt_table;
 750         /* number of CPTs in ln_cpt_table */
 751         unsigned int                    ln_cpt_number;
 752         unsigned int                    ln_cpt_bits;
 753
 754         /* protect LNet resources (ME/MD/EQ) */
 755         struct cfs_percpt_lock          *ln_res_lock;
 756         /* # portals */
 757         int                             ln_nportals;
 758         /* the vector of portals */
 759         lnet_portal_t                   **ln_portals;
 760         /* percpt ME containers */
 761         struct lnet_res_container       **ln_me_containers;
 762         /* percpt MD container */
 763         struct lnet_res_container       **ln_md_containers;
 764
 765         /* Event Queue container */
 766         struct lnet_res_container       ln_eq_container;
 767 #ifdef __KERNEL__
 768         wait_queue_head_t               ln_eq_waitq;
 769         spinlock_t                      ln_eq_wait_lock;
 770 #else
 771 # ifndef HAVE_LIBPTHREAD
 772         int                             ln_eq_wait_lock;
 773 # else
 774         pthread_cond_t                  ln_eq_cond;
 775         pthread_mutex_t                 ln_eq_wait_lock;
 776 # endif
 777 #endif
 778         unsigned int                    ln_remote_nets_hbits;
 779
 780         /* protect NI, peer table, credits, routers, rtrbuf... */
 781         struct cfs_percpt_lock          *ln_net_lock;
 782         /* percpt message containers for active/finalizing/freed message */
 783         struct lnet_msg_container       **ln_msg_containers;
 784         lnet_counters_t                 **ln_counters;
 785         struct lnet_peer_table          **ln_peer_tables;
 786         /* failure simulation */
 787         struct list_head                ln_test_peers;
 788         struct list_head                ln_drop_rules;
 789         struct list_head                ln_delay_rules;
 790
 791         struct list_head                ln_nis;         /* LND instances */
 792         /* NIs bond on specific CPT(s) */
 793         struct list_head                ln_nis_cpt;
 794         /* dying LND instances */
 795         struct list_head                ln_nis_zombie;
 796         lnet_ni_t                       *ln_loni;       /* the loopback NI */
 797         /* NI to wait for events in */
 798         lnet_ni_t                       *ln_eq_waitni;
 799
 800         /* remote networks with routes to them */
 801         struct list_head                *ln_remote_nets_hash;
 802         /* validity stamp */
 803         __u64                           ln_remote_nets_version;
 804         /* list of all known routers */
 805         struct list_head                ln_routers;
 806         /* validity stamp */
 807         __u64                           ln_routers_version;
 808         /* percpt router buffer pools */
 809         lnet_rtrbufpool_t               **ln_rtrpools;
 810
 811         lnet_handle_md_t                ln_ping_target_md;
 812         lnet_handle_eq_t                ln_ping_target_eq;
 813         lnet_ping_info_t                *ln_ping_info;
 814
 815         /* router checker startup/shutdown state */
 816         int                             ln_rc_state;
 817         /* router checker's event queue */
 818         lnet_handle_eq_t                ln_rc_eqh;
 819         /* rcd still pending on net */
 820         struct list_head                ln_rcd_deathrow;
 821         /* rcd ready for free */
 822         struct list_head                ln_rcd_zombie;
 823 #ifdef __KERNEL__
 824         /* serialise startup/shutdown */
 825         struct semaphore                ln_rc_signal;
 826
 827         struct mutex                    ln_api_mutex;
 828         struct mutex                    ln_lnd_mutex;
 829         struct mutex                    ln_delay_mutex;
 830 #else
 831 # ifndef HAVE_LIBPTHREAD
 832         int                             ln_api_mutex;
 833         int                             ln_lnd_mutex;
 834 # else
 835         pthread_mutex_t                 ln_api_mutex;
 836         pthread_mutex_t                 ln_lnd_mutex;
 837 # endif
 838 #endif
 839         int                             ln_init;        /* LNetInit() called? */
 840         /* Have I called LNetNIInit myself? */
 841         int                             ln_niinit_self;
 842         /* LNetNIInit/LNetNIFini counter */
 843         int                             ln_refcount;
 844         /* shutdown in progress */
 845         int                             ln_shutdown;
 846
 847         int                             ln_routing;     /* am I a router? */
 848         lnet_pid_t                      ln_pid;         /* requested pid */
 849         /* uniquely identifies this ni in this epoch */
 850         __u64                           ln_interface_cookie;
 851         /* registered LNDs */
 852         struct list_head                ln_lnds;
 853
 854         /* test protocol compatibility flags */
 855         int                             ln_testprotocompat;
 856
 857         /* 0 - load the NIs from the mod params
 858          * 1 - do not load the NIs from the mod params
 859          * Reverse logic to ensure that other calls to LNetNIInit
 860          * need no change
 861          */
 862         bool                            ln_nis_from_mod_params;
 863
 864 #ifndef __KERNEL__
 865         /* Temporary workaround to allow uOSS and test programs force
 866          * server mode in userspace. The only place where we use it is
 867          * lnet_prepare(). The only way to turn this flag on is to
 868          * call lnet_server_mode() */
 869         int                             ln_server_mode_flag;
 870 #endif
 871 } lnet_t;
 872
 873 #endif