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