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