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