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