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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lnet/include/lnet/lib-types.h
  33  *
  34  * Types used by the library side routines that do not need to be
  35  * exposed to the user application
  36  */
  37
  38 #ifndef __LNET_LIB_TYPES_H__
  39 #define __LNET_LIB_TYPES_H__
  40
  41 #ifndef __KERNEL__
  42 # error This include is only for kernel use.
  43 #endif
  44
  45 #include <linux/kthread.h>
  46 #include <linux/uio.h>
  47 #include <linux/semaphore.h>
  48 #include <linux/types.h>
  49
  50 #include <uapi/linux/lnet/lnet-dlc.h>
  51 #include <uapi/linux/lnet/lnetctl.h>
  52 #include <uapi/linux/lnet/nidstr.h>
  53
  54 /* Max payload size */
  55 #define LNET_MAX_PAYLOAD        LNET_MTU
  56
  57 #define LNET_MAX_IOV            (LNET_MAX_PAYLOAD >> PAGE_SHIFT)
  58
  59 /*
  60  * This is the maximum health value.
  61  * All local and peer NIs created have their health default to this value.
  62  */
  63 #define LNET_MAX_HEALTH_VALUE 1000
  64
  65 /* forward refs */
  66 struct lnet_libmd;
  67
  68 enum lnet_msg_hstatus {
  69         LNET_MSG_STATUS_OK = 0,
  70         LNET_MSG_STATUS_LOCAL_INTERRUPT,
  71         LNET_MSG_STATUS_LOCAL_DROPPED,
  72         LNET_MSG_STATUS_LOCAL_ABORTED,
  73         LNET_MSG_STATUS_LOCAL_NO_ROUTE,
  74         LNET_MSG_STATUS_LOCAL_ERROR,
  75         LNET_MSG_STATUS_LOCAL_TIMEOUT,
  76         LNET_MSG_STATUS_REMOTE_ERROR,
  77         LNET_MSG_STATUS_REMOTE_DROPPED,
  78         LNET_MSG_STATUS_REMOTE_TIMEOUT,
  79         LNET_MSG_STATUS_NETWORK_TIMEOUT,
  80         LNET_MSG_STATUS_END,
  81 };
  82
  83 struct lnet_rsp_tracker {
  84         /* chain on the waiting list */
  85         struct list_head rspt_on_list;
  86         /* cpt to lock */
  87         int rspt_cpt;
  88         /* nid of next hop */
  89         lnet_nid_t rspt_next_hop_nid;
  90         /* deadline of the REPLY/ACK */
  91         ktime_t rspt_deadline;
  92         /* parent MD */
  93         struct lnet_handle_md rspt_mdh;
  94 };
  95
  96 struct lnet_msg {
  97         struct list_head        msg_activelist;
  98         struct list_head        msg_list;       /* Q for credits/MD */
  99
 100         struct lnet_process_id  msg_target;
 101         /* Primary NID of the source. */
 102         lnet_nid_t              msg_initiator;
 103         /* where is it from, it's only for building event */
 104         lnet_nid_t              msg_from;
 105         __u32                   msg_type;
 106
 107         /*
 108          * hold parameters in case message is with held due
 109          * to discovery
 110          */
 111         lnet_nid_t              msg_src_nid_param;
 112         lnet_nid_t              msg_rtr_nid_param;
 113
 114         /*
 115          * Deadline for the message after which it will be finalized if it
 116          * has not completed.
 117          */
 118         ktime_t                 msg_deadline;
 119
 120         /* The message health status. */
 121         enum lnet_msg_hstatus   msg_health_status;
 122         /* This is a recovery message */
 123         bool                    msg_recovery;
 124         /* the number of times a transmission has been retried */
 125         int                     msg_retry_count;
 126         /* flag to indicate that we do not want to resend this message */
 127         bool                    msg_no_resend;
 128
 129         /* committed for sending */
 130         unsigned int            msg_tx_committed:1;
 131         /* CPT # this message committed for sending */
 132         unsigned int            msg_tx_cpt:15;
 133         /* committed for receiving */
 134         unsigned int            msg_rx_committed:1;
 135         /* CPT # this message committed for receiving */
 136         unsigned int            msg_rx_cpt:15;
 137         /* queued for tx credit */
 138         unsigned int            msg_tx_delayed:1;
 139         /* queued for RX buffer */
 140         unsigned int            msg_rx_delayed:1;
 141         /* ready for pending on RX delay list */
 142         unsigned int            msg_rx_ready_delay:1;
 143
 144         unsigned int          msg_vmflush:1;      /* VM trying to free memory */
 145         unsigned int          msg_target_is_router:1; /* sending to a router */
 146         unsigned int          msg_routing:1;      /* being forwarded */
 147         unsigned int          msg_ack:1;          /* ack on finalize (PUT) */
 148         unsigned int          msg_sending:1;      /* outgoing message */
 149         unsigned int          msg_receiving:1;    /* being received */
 150         unsigned int          msg_txcredit:1;     /* taken an NI send credit */
 151         unsigned int          msg_peertxcredit:1; /* taken a peer send credit */
 152         unsigned int          msg_rtrcredit:1;    /* taken a globel router credit */
 153         unsigned int          msg_peerrtrcredit:1; /* taken a peer router credit */
 154         unsigned int          msg_onactivelist:1; /* on the activelist */
 155         unsigned int          msg_rdma_get:1;
 156
 157         struct lnet_peer_ni  *msg_txpeer;         /* peer I'm sending to */
 158         struct lnet_peer_ni  *msg_rxpeer;         /* peer I received from */
 159
 160         void                 *msg_private;
 161         struct lnet_libmd    *msg_md;
 162         /* the NI the message was sent or received over */
 163         struct lnet_ni       *msg_txni;
 164         struct lnet_ni       *msg_rxni;
 165
 166         unsigned int          msg_len;
 167         unsigned int          msg_wanted;
 168         unsigned int          msg_offset;
 169         unsigned int          msg_niov;
 170         struct kvec          *msg_iov;
 171         struct bio_vec       *msg_kiov;
 172
 173         struct lnet_event       msg_ev;
 174         struct lnet_hdr         msg_hdr;
 175 };
 176
 177 struct lnet_libhandle {
 178         struct list_head        lh_hash_chain;
 179         __u64                   lh_cookie;
 180 };
 181
 182 #define lh_entry(ptr, type, member) \
 183         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
 184
 185 struct lnet_me {
 186         struct list_head        me_list;
 187         int                     me_cpt;
 188         struct lnet_process_id  me_match_id;
 189         unsigned int            me_portal;
 190         unsigned int            me_pos;         /* hash offset in mt_hash */
 191         __u64                   me_match_bits;
 192         __u64                   me_ignore_bits;
 193         enum lnet_unlink        me_unlink;
 194         struct lnet_libmd      *me_md;
 195 };
 196
 197 struct lnet_libmd {
 198         struct list_head         md_list;
 199         struct lnet_libhandle    md_lh;
 200         struct lnet_me          *md_me;
 201         char                    *md_start;
 202         unsigned int             md_offset;
 203         unsigned int             md_length;
 204         unsigned int             md_max_size;
 205         int                      md_threshold;
 206         int                      md_refcount;
 207         unsigned int             md_options;
 208         unsigned int             md_flags;
 209         unsigned int             md_niov;       /* # frags at end of struct */
 210         void                    *md_user_ptr;
 211         struct lnet_rsp_tracker *md_rspt_ptr;
 212         lnet_eq_handler_t        md_eq;
 213         struct lnet_handle_md    md_bulk_handle;
 214         union {
 215                 struct kvec      iov[LNET_MAX_IOV];
 216                 struct bio_vec   kiov[LNET_MAX_IOV];
 217         } md_iov;
 218 };
 219
 220 #define LNET_MD_FLAG_ZOMBIE      (1 << 0)
 221 #define LNET_MD_FLAG_AUTO_UNLINK (1 << 1)
 222 #define LNET_MD_FLAG_ABORTED     (1 << 2)
 223
 224 struct lnet_test_peer {
 225         /* info about peers we are trying to fail */
 226         struct list_head        tp_list;        /* ln_test_peers */
 227         lnet_nid_t              tp_nid;         /* matching nid */
 228         unsigned int            tp_threshold;   /* # failures to simulate */
 229 };
 230
 231 #define LNET_COOKIE_TYPE_MD    1
 232 #define LNET_COOKIE_TYPE_ME    2
 233 #define LNET_COOKIE_TYPE_EQ    3
 234 #define LNET_COOKIE_TYPE_BITS  2
 235 #define LNET_COOKIE_MASK        ((1ULL << LNET_COOKIE_TYPE_BITS) - 1ULL)
 236
 237 struct lnet_ni;                                  /* forward ref */
 238 struct socket;
 239
 240 struct lnet_lnd {
 241         /* fields initialized by the LND */
 242         __u32                   lnd_type;
 243
 244         int  (*lnd_startup)(struct lnet_ni *ni);
 245         void (*lnd_shutdown)(struct lnet_ni *ni);
 246         int  (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
 247
 248         /* In data movement APIs below, payload buffers are described as a set
 249          * of 'niov' fragments which are...
 250          * EITHER
 251          *    in virtual memory (struct kvec *iov != NULL)
 252          * OR
 253          *    in pages (kernel only: plt_kiov_t *kiov != NULL).
 254          * The LND may NOT overwrite these fragment descriptors.
 255          * An 'offset' and may specify a byte offset within the set of
 256          * fragments to start from
 257          */
 258
 259         /* Start sending a preformatted message.  'private' is NULL for PUT and
 260          * GET messages; otherwise this is a response to an incoming message
 261          * and 'private' is the 'private' passed to lnet_parse().  Return
 262          * non-zero for immediate failure, otherwise complete later with
 263          * lnet_finalize() */
 264         int (*lnd_send)(struct lnet_ni *ni, void *private,
 265                         struct lnet_msg *msg);
 266
 267         /* Start receiving 'mlen' bytes of payload data, skipping the following
 268          * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
 269          * lnet_parse().  Return non-zero for immedaite failure, otherwise
 270          * complete later with lnet_finalize().  This also gives back a receive
 271          * credit if the LND does flow control. */
 272         int (*lnd_recv)(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
 273                         int delayed, unsigned int niov,
 274                         struct kvec *iov, struct bio_vec *kiov,
 275                         unsigned int offset, unsigned int mlen, unsigned int rlen);
 276
 277         /* lnet_parse() has had to delay processing of this message
 278          * (e.g. waiting for a forwarding buffer or send credits).  Give the
 279          * LND a chance to free urgently needed resources.  If called, return 0
 280          * for success and do NOT give back a receive credit; that has to wait
 281          * until lnd_recv() gets called.  On failure return < 0 and
 282          * release resources; lnd_recv() will not be called. */
 283         int (*lnd_eager_recv)(struct lnet_ni *ni, void *private,
 284                               struct lnet_msg *msg, void **new_privatep);
 285
 286         /* notification of peer down */
 287         void (*lnd_notify_peer_down)(lnet_nid_t peer);
 288
 289         /* accept a new connection */
 290         int (*lnd_accept)(struct lnet_ni *ni, struct socket *sock);
 291 };
 292
 293 struct lnet_tx_queue {
 294         int                     tq_credits;     /* # tx credits free */
 295         int                     tq_credits_min; /* lowest it's been */
 296         int                     tq_credits_max; /* total # tx credits */
 297         struct list_head        tq_delayed;     /* delayed TXs */
 298 };
 299
 300 enum lnet_net_state {
 301         /* set when net block is allocated */
 302         LNET_NET_STATE_INIT = 0,
 303         /* set when NIs in net are started successfully */
 304         LNET_NET_STATE_ACTIVE,
 305         /* set if all NIs in net are in FAILED state */
 306         LNET_NET_STATE_INACTIVE,
 307         /* set when shutting down a NET */
 308         LNET_NET_STATE_DELETING
 309 };
 310
 311 enum lnet_ni_state {
 312         /* initial state when NI is created */
 313         LNET_NI_STATE_INIT = 0,
 314         /* set when NI is brought up */
 315         LNET_NI_STATE_ACTIVE,
 316         /* set when NI is being shutdown */
 317         LNET_NI_STATE_DELETING,
 318 };
 319
 320 #define LNET_NI_RECOVERY_PENDING        BIT(0)
 321 #define LNET_NI_RECOVERY_FAILED         BIT(1)
 322
 323 enum lnet_stats_type {
 324         LNET_STATS_TYPE_SEND = 0,
 325         LNET_STATS_TYPE_RECV,
 326         LNET_STATS_TYPE_DROP
 327 };
 328
 329 struct lnet_comm_count {
 330         atomic_t co_get_count;
 331         atomic_t co_put_count;
 332         atomic_t co_reply_count;
 333         atomic_t co_ack_count;
 334         atomic_t co_hello_count;
 335 };
 336
 337 struct lnet_element_stats {
 338         struct lnet_comm_count el_send_stats;
 339         struct lnet_comm_count el_recv_stats;
 340         struct lnet_comm_count el_drop_stats;
 341 };
 342
 343 struct lnet_health_local_stats {
 344         atomic_t hlt_local_interrupt;
 345         atomic_t hlt_local_dropped;
 346         atomic_t hlt_local_aborted;
 347         atomic_t hlt_local_no_route;
 348         atomic_t hlt_local_timeout;
 349         atomic_t hlt_local_error;
 350 };
 351
 352 struct lnet_health_remote_stats {
 353         atomic_t hlt_remote_dropped;
 354         atomic_t hlt_remote_timeout;
 355         atomic_t hlt_remote_error;
 356         atomic_t hlt_network_timeout;
 357 };
 358
 359 struct lnet_net {
 360         /* chain on the ln_nets */
 361         struct list_head        net_list;
 362
 363         /* net ID, which is composed of
 364          * (net_type << 16) | net_num.
 365          * net_type can be one of the enumerated types defined in
 366          * lnet/include/lnet/nidstr.h */
 367         __u32                   net_id;
 368
 369         /* priority of the network */
 370         __u32                   net_prio;
 371
 372         /* total number of CPTs in the array */
 373         __u32                   net_ncpts;
 374
 375         /* cumulative CPTs of all NIs in this net */
 376         __u32                   *net_cpts;
 377
 378         /* network tunables */
 379         struct lnet_ioctl_config_lnd_cmn_tunables net_tunables;
 380
 381         /*
 382          * boolean to indicate that the tunables have been set and
 383          * shouldn't be reset
 384          */
 385         bool                    net_tunables_set;
 386
 387         /* procedural interface */
 388         const struct lnet_lnd   *net_lnd;
 389
 390         /* list of NIs on this net */
 391         struct list_head        net_ni_list;
 392
 393         /* list of NIs being added, but not started yet */
 394         struct list_head        net_ni_added;
 395
 396         /* dying LND instances */
 397         struct list_head        net_ni_zombie;
 398
 399         /* when I was last alive */
 400         time64_t                net_last_alive;
 401
 402         /* protects access to net_last_alive */
 403         spinlock_t              net_lock;
 404 };
 405
 406 struct lnet_ni {
 407         /* chain on the lnet_net structure */
 408         struct list_head        ni_netlist;
 409
 410         /* chain on the recovery queue */
 411         struct list_head        ni_recovery;
 412
 413         /* MD handle for recovery ping */
 414         struct lnet_handle_md   ni_ping_mdh;
 415
 416         spinlock_t              ni_lock;
 417
 418         /* number of CPTs */
 419         int                     ni_ncpts;
 420
 421         /* bond NI on some CPTs */
 422         __u32                   *ni_cpts;
 423
 424         /* interface's NID */
 425         lnet_nid_t              ni_nid;
 426
 427         /* instance-specific data */
 428         void                    *ni_data;
 429
 430         /* per ni credits */
 431         atomic_t                ni_tx_credits;
 432
 433         /* percpt TX queues */
 434         struct lnet_tx_queue    **ni_tx_queues;
 435
 436         /* percpt reference count */
 437         int                     **ni_refs;
 438
 439         /* pointer to parent network */
 440         struct lnet_net         *ni_net;
 441
 442         /* my health status */
 443         struct lnet_ni_status   *ni_status;
 444
 445         /* NI FSM. Protected by lnet_ni_lock() */
 446         enum lnet_ni_state      ni_state;
 447
 448         /* Recovery state. Protected by lnet_ni_lock() */
 449         __u32                   ni_recovery_state;
 450
 451         /* per NI LND tunables */
 452         struct lnet_lnd_tunables ni_lnd_tunables;
 453
 454         /* lnd tunables set explicitly */
 455         bool ni_lnd_tunables_set;
 456
 457         /* NI statistics */
 458         struct lnet_element_stats ni_stats;
 459         struct lnet_health_local_stats ni_hstats;
 460
 461         /* physical device CPT */
 462         int                     ni_dev_cpt;
 463
 464         /* sequence number used to round robin over nis within a net */
 465         __u32                   ni_seq;
 466
 467         /*
 468          * health value
 469          *      initialized to LNET_MAX_HEALTH_VALUE
 470          * Value is decremented every time we fail to send a message over
 471          * this NI because of a NI specific failure.
 472          * Value is incremented if we successfully send a message.
 473          */
 474         atomic_t                ni_healthv;
 475
 476         /*
 477          * Set to 1 by the LND when it receives an event telling it the device
 478          * has gone into a fatal state. Set to 0 when the LND receives an
 479          * even telling it the device is back online.
 480          */
 481         atomic_t                ni_fatal_error_on;
 482
 483         /*
 484          * equivalent interfaces to use
 485          * This is an array because socklnd bonding can still be configured
 486          */
 487         char                    *ni_interfaces[LNET_INTERFACES_NUM];
 488         struct net              *ni_net_ns;     /* original net namespace */
 489 };
 490
 491 #define LNET_PROTO_PING_MATCHBITS       0x8000000000000000LL
 492
 493 /*
 494  * Descriptor of a ping info buffer: keep a separate indicator of the
 495  * size and a reference count. The type is used both as a source and
 496  * sink of data, so we need to keep some information outside of the
 497  * area that may be overwritten by network data.
 498  */
 499 struct lnet_ping_buffer {
 500         int                     pb_nnis;
 501         atomic_t                pb_refcnt;
 502         bool                    pb_needs_post;
 503         struct lnet_ping_info   pb_info;
 504 };
 505
 506 #define LNET_PING_BUFFER_SIZE(NNIDS) \
 507         offsetof(struct lnet_ping_buffer, pb_info.pi_ni[NNIDS])
 508 #define LNET_PING_BUFFER_LONI(PBUF)     ((PBUF)->pb_info.pi_ni[0].ns_nid)
 509 #define LNET_PING_BUFFER_SEQNO(PBUF)    ((PBUF)->pb_info.pi_ni[0].ns_status)
 510
 511 #define LNET_PING_INFO_TO_BUFFER(PINFO) \
 512         container_of((PINFO), struct lnet_ping_buffer, pb_info)
 513
 514 struct lnet_peer_ni {
 515         /* chain on lpn_peer_nis */
 516         struct list_head        lpni_peer_nis;
 517         /* chain on remote peer list */
 518         struct list_head        lpni_on_remote_peer_ni_list;
 519         /* chain on recovery queue */
 520         struct list_head        lpni_recovery;
 521         /* chain on peer hash */
 522         struct list_head        lpni_hashlist;
 523         /* messages blocking for tx credits */
 524         struct list_head        lpni_txq;
 525         /* pointer to peer net I'm part of */
 526         struct lnet_peer_net    *lpni_peer_net;
 527         /* statistics kept on each peer NI */
 528         struct lnet_element_stats lpni_stats;
 529         struct lnet_health_remote_stats lpni_hstats;
 530         /* spin lock protecting credits and lpni_txq */
 531         spinlock_t              lpni_lock;
 532         /* # tx credits available */
 533         int                     lpni_txcredits;
 534         /* low water mark */
 535         int                     lpni_mintxcredits;
 536         /*
 537          * Each peer_ni in a gateway maintains its own credits. This
 538          * allows more traffic to gateways that have multiple interfaces.
 539          */
 540         /* # router credits */
 541         int                     lpni_rtrcredits;
 542         /* low water mark */
 543         int                     lpni_minrtrcredits;
 544         /* bytes queued for sending */
 545         long                    lpni_txqnob;
 546         /* network peer is on */
 547         struct lnet_net         *lpni_net;
 548         /* peer's NID */
 549         lnet_nid_t              lpni_nid;
 550         /* # refs */
 551         atomic_t                lpni_refcount;
 552         /* health value for the peer */
 553         atomic_t                lpni_healthv;
 554         /* recovery ping mdh */
 555         struct lnet_handle_md   lpni_recovery_ping_mdh;
 556         /* CPT this peer attached on */
 557         int                     lpni_cpt;
 558         /* state flags -- protected by lpni_lock */
 559         unsigned                lpni_state;
 560         /* status of the peer NI as reported by the peer */
 561         __u32                   lpni_ns_status;
 562         /* sequence number used to round robin over peer nis within a net */
 563         __u32                   lpni_seq;
 564         /* sequence number used to round robin over gateways */
 565         __u32                   lpni_gw_seq;
 566         /* returned RC ping features. Protected with lpni_lock */
 567         unsigned int            lpni_ping_feats;
 568         /* time last message was received from the peer */
 569         time64_t                lpni_last_alive;
 570         /* preferred local nids: if only one, use lpni_pref.nid */
 571         union lpni_pref {
 572                 lnet_nid_t      nid;
 573                 lnet_nid_t      *nids;
 574         } lpni_pref;
 575         /* number of preferred NIDs in lnpi_pref_nids */
 576         __u32                   lpni_pref_nnids;
 577 };
 578
 579 /* Preferred path added due to traffic on non-MR peer_ni */
 580 #define LNET_PEER_NI_NON_MR_PREF        (1 << 0)
 581 /* peer is being recovered. */
 582 #define LNET_PEER_NI_RECOVERY_PENDING   (1 << 1)
 583 /* recovery ping failed */
 584 #define LNET_PEER_NI_RECOVERY_FAILED    (1 << 2)
 585 /* peer is being deleted */
 586 #define LNET_PEER_NI_DELETING           (1 << 3)
 587
 588 struct lnet_peer {
 589         /* chain on pt_peer_list */
 590         struct list_head        lp_peer_list;
 591
 592         /* list of peer nets */
 593         struct list_head        lp_peer_nets;
 594
 595         /* list of messages pending discovery*/
 596         struct list_head        lp_dc_pendq;
 597
 598         /* chain on router list */
 599         struct list_head        lp_rtr_list;
 600
 601         /* primary NID of the peer */
 602         lnet_nid_t              lp_primary_nid;
 603
 604         /* net to perform discovery on */
 605         __u32                   lp_disc_net_id;
 606
 607         /* CPT of peer_table */
 608         int                     lp_cpt;
 609
 610         /* number of NIDs on this peer */
 611         int                     lp_nnis;
 612
 613         /* # refs from lnet_route::lr_gateway */
 614         int                     lp_rtr_refcount;
 615
 616         /*
 617          * peer specific health sensitivity value to decrement peer nis in
 618          * this peer with if set to something other than 0
 619          */
 620         __u32                   lp_health_sensitivity;
 621
 622         /* messages blocking for router credits */
 623         struct list_head        lp_rtrq;
 624
 625         /* routes on this peer */
 626         struct list_head        lp_routes;
 627
 628         /* reference count */
 629         atomic_t                lp_refcount;
 630
 631         /* lock protecting peer state flags and lpni_rtrq */
 632         spinlock_t              lp_lock;
 633
 634         /* peer state flags */
 635         unsigned                lp_state;
 636
 637         /* buffer for data pushed by peer */
 638         struct lnet_ping_buffer *lp_data;
 639
 640         /* MD handle for ping in progress */
 641         struct lnet_handle_md   lp_ping_mdh;
 642
 643         /* MD handle for push in progress */
 644         struct lnet_handle_md   lp_push_mdh;
 645
 646         /* number of NIDs for sizing push data */
 647         int                     lp_data_nnis;
 648
 649         /* NI config sequence number of peer */
 650         __u32                   lp_peer_seqno;
 651
 652         /* Local NI config sequence number acked by peer */
 653         __u32                   lp_node_seqno;
 654
 655         /* Local NI config sequence number sent to peer */
 656         __u32                   lp_node_seqno_sent;
 657
 658         /* Ping error encountered during discovery. */
 659         int                     lp_ping_error;
 660
 661         /* Push error encountered during discovery. */
 662         int                     lp_push_error;
 663
 664         /* Error encountered during discovery. */
 665         int                     lp_dc_error;
 666
 667         /* time it was put on the ln_dc_working queue */
 668         time64_t                lp_last_queued;
 669
 670         /* link on discovery-related lists */
 671         struct list_head        lp_dc_list;
 672
 673         /* tasks waiting on discovery of this peer */
 674         wait_queue_head_t       lp_dc_waitq;
 675
 676         /* cached peer aliveness */
 677         bool                    lp_alive;
 678 };
 679
 680 /*
 681  * The status flags in lp_state. Their semantics have chosen so that
 682  * lp_state can be zero-initialized.
 683  *
 684  * A peer is marked MULTI_RAIL in two cases: it was configured using DLC
 685  * as multi-rail aware, or the LNET_PING_FEAT_MULTI_RAIL bit was set.
 686  *
 687  * A peer is marked NO_DISCOVERY if the LNET_PING_FEAT_DISCOVERY bit was
 688  * NOT set when the peer was pinged by discovery.
 689  *
 690  * A peer is marked ROUTER if it indicates so in the feature bit.
 691  */
 692 #define LNET_PEER_MULTI_RAIL    (1 << 0)        /* Multi-rail aware */
 693 #define LNET_PEER_NO_DISCOVERY  (1 << 1)        /* Peer disabled discovery */
 694 #define LNET_PEER_ROUTER_ENABLED (1 << 2)       /* router feature enabled */
 695
 696 /*
 697  * A peer is marked CONFIGURED if it was configured by DLC.
 698  *
 699  * In addition, a peer is marked DISCOVERED if it has fully passed
 700  * through Peer Discovery.
 701  *
 702  * When Peer Discovery is disabled, the discovery thread will mark
 703  * peers REDISCOVER to indicate that they should be re-examined if
 704  * discovery is (re)enabled on the node.
 705  *
 706  * A peer that was created as the result of inbound traffic will not
 707  * be marked at all.
 708  */
 709 #define LNET_PEER_CONFIGURED    (1 << 3)        /* Configured via DLC */
 710 #define LNET_PEER_DISCOVERED    (1 << 4)        /* Peer was discovered */
 711 #define LNET_PEER_REDISCOVER    (1 << 5)        /* Discovery was disabled */
 712 /*
 713  * A peer is marked DISCOVERING when discovery is in progress.
 714  * The other flags below correspond to stages of discovery.
 715  */
 716 #define LNET_PEER_DISCOVERING   (1 << 6)        /* Discovering */
 717 #define LNET_PEER_DATA_PRESENT  (1 << 7)        /* Remote peer data present */
 718 #define LNET_PEER_NIDS_UPTODATE (1 << 8)        /* Remote peer info uptodate */
 719 #define LNET_PEER_PING_SENT     (1 << 9)        /* Waiting for REPLY to Ping */
 720 #define LNET_PEER_PUSH_SENT     (1 << 10)       /* Waiting for ACK of Push */
 721 #define LNET_PEER_PING_FAILED   (1 << 11)       /* Ping send failure */
 722 #define LNET_PEER_PUSH_FAILED   (1 << 12)       /* Push send failure */
 723 /*
 724  * A ping can be forced as a way to fix up state, or as a manual
 725  * intervention by an admin.
 726  * A push can be forced in circumstances that would normally not
 727  * allow for one to happen.
 728  */
 729 #define LNET_PEER_FORCE_PING    (1 << 13)       /* Forced Ping */
 730 #define LNET_PEER_FORCE_PUSH    (1 << 14)       /* Forced Push */
 731
 732 /* force delete even if router */
 733 #define LNET_PEER_RTR_NI_FORCE_DEL (1 << 15)
 734
 735 /* gw undergoing alive discovery */
 736 #define LNET_PEER_RTR_DISCOVERY (1 << 16)
 737 /* gw has undergone discovery (does not indicate success or failure) */
 738 #define LNET_PEER_RTR_DISCOVERED (1 << 17)
 739
 740 /* peer is marked for deletion */
 741 #define LNET_PEER_MARK_DELETION (1 << 18)
 742
 743 struct lnet_peer_net {
 744         /* chain on lp_peer_nets */
 745         struct list_head        lpn_peer_nets;
 746
 747         /* list of peer_nis on this network */
 748         struct list_head        lpn_peer_nis;
 749
 750         /* pointer to the peer I'm part of */
 751         struct lnet_peer        *lpn_peer;
 752
 753         /* Net ID */
 754         __u32                   lpn_net_id;
 755
 756         /* peer net health */
 757         int                     lpn_healthv;
 758
 759         /* time of last router net check attempt */
 760         time64_t                lpn_rtrcheck_timestamp;
 761
 762         /* selection sequence number */
 763         __u32                   lpn_seq;
 764
 765         /* reference count */
 766         atomic_t                lpn_refcount;
 767 };
 768
 769 /* peer hash size */
 770 #define LNET_PEER_HASH_BITS     9
 771 #define LNET_PEER_HASH_SIZE     (1 << LNET_PEER_HASH_BITS)
 772
 773 /*
 774  * peer hash table - one per CPT
 775  *
 776  * protected by lnet_net_lock/EX for update
 777  *    pt_version
 778  *    pt_hash[...]
 779  *    pt_peer_list
 780  *    pt_peers
 781  * protected by pt_zombie_lock:
 782  *    pt_zombie_list
 783  *    pt_zombies
 784  *
 785  * pt_zombie lock nests inside lnet_net_lock
 786  */
 787 struct lnet_peer_table {
 788         int                     pt_version;     /* /proc validity stamp */
 789         struct list_head        *pt_hash;       /* NID->peer hash */
 790         struct list_head        pt_peer_list;   /* peers */
 791         int                     pt_peers;       /* # peers */
 792         struct list_head        pt_zombie_list; /* zombie peer_ni */
 793         int                     pt_zombies;     /* # zombie peers_ni */
 794         spinlock_t              pt_zombie_lock; /* protect list and count */
 795 };
 796
 797 /* peer aliveness is enabled only on routers for peers in a network where the
 798  * struct lnet_ni::ni_peertimeout has been set to a positive value
 799  */
 800 #define lnet_peer_aliveness_enabled(lp) (the_lnet.ln_routing != 0 && \
 801                                         ((lp)->lpni_net) && \
 802                                         (lp)->lpni_net->net_tunables.lct_peer_timeout > 0)
 803
 804 struct lnet_route {
 805         struct list_head        lr_list;        /* chain on net */
 806         struct list_head        lr_gwlist;      /* chain on gateway */
 807         struct lnet_peer        *lr_gateway;    /* router node */
 808         lnet_nid_t              lr_nid;         /* NID used to add route */
 809         __u32                   lr_net;         /* remote network number */
 810         __u32                   lr_lnet;        /* local network number */
 811         int                     lr_seq;         /* sequence for round-robin */
 812         __u32                   lr_hops;        /* how far I am */
 813         unsigned int            lr_priority;    /* route priority */
 814         bool                    lr_alive;       /* cached route aliveness */
 815         bool                    lr_single_hop;  /* this route is single-hop */
 816 };
 817
 818 #define LNET_REMOTE_NETS_HASH_DEFAULT   (1U << 7)
 819 #define LNET_REMOTE_NETS_HASH_MAX       (1U << 16)
 820 #define LNET_REMOTE_NETS_HASH_SIZE      (1 << the_lnet.ln_remote_nets_hbits)
 821
 822 struct lnet_remotenet {
 823         /* chain on ln_remote_nets_hash */
 824         struct list_head        lrn_list;
 825         /* routes to me */
 826         struct list_head        lrn_routes;
 827         /* my net number */
 828         __u32                   lrn_net;
 829 };
 830
 831 /** lnet message has credit and can be submitted to lnd for send/receive */
 832 #define LNET_CREDIT_OK          0
 833 /** lnet message is waiting for credit */
 834 #define LNET_CREDIT_WAIT        1
 835 /** lnet message is waiting for discovery */
 836 #define LNET_DC_WAIT            2
 837
 838 struct lnet_rtrbufpool {
 839         /* my free buffer pool */
 840         struct list_head        rbp_bufs;
 841         /* messages blocking for a buffer */
 842         struct list_head        rbp_msgs;
 843         /* # pages in each buffer */
 844         int                     rbp_npages;
 845         /* requested number of buffers */
 846         int                     rbp_req_nbuffers;
 847         /* # buffers actually allocated */
 848         int                     rbp_nbuffers;
 849         /* # free buffers / blocked messages */
 850         int                     rbp_credits;
 851         /* low water mark */
 852         int                     rbp_mincredits;
 853 };
 854
 855 struct lnet_rtrbuf {
 856         struct list_head         rb_list;       /* chain on rbp_bufs */
 857         struct lnet_rtrbufpool  *rb_pool;       /* owning pool */
 858         struct bio_vec           rb_kiov[0];    /* the buffer space */
 859 };
 860
 861 #define LNET_PEER_HASHSIZE   503                /* prime! */
 862
 863 enum lnet_match_flags {
 864         /* Didn't match anything */
 865         LNET_MATCHMD_NONE       = (1 << 0),
 866         /* Matched OK */
 867         LNET_MATCHMD_OK         = (1 << 1),
 868         /* Must be discarded */
 869         LNET_MATCHMD_DROP       = (1 << 2),
 870         /* match and buffer is exhausted */
 871         LNET_MATCHMD_EXHAUSTED  = (1 << 3),
 872         /* match or drop */
 873         LNET_MATCHMD_FINISH     = (LNET_MATCHMD_OK | LNET_MATCHMD_DROP),
 874 };
 875
 876 /* Options for struct lnet_portal::ptl_options */
 877 #define LNET_PTL_LAZY               (1 << 0)
 878 #define LNET_PTL_MATCH_UNIQUE       (1 << 1)    /* unique match, for RDMA */
 879 #define LNET_PTL_MATCH_WILDCARD     (1 << 2)    /* wildcard match, request portal */
 880
 881 /* parameter for matching operations (GET, PUT) */
 882 struct lnet_match_info {
 883         __u64                   mi_mbits;
 884         struct lnet_process_id  mi_id;
 885         unsigned int            mi_cpt;
 886         unsigned int            mi_opc;
 887         unsigned int            mi_portal;
 888         unsigned int            mi_rlength;
 889         unsigned int            mi_roffset;
 890 };
 891
 892 /* ME hash of RDMA portal */
 893 #define LNET_MT_HASH_BITS               8
 894 #define LNET_MT_HASH_SIZE               (1 << LNET_MT_HASH_BITS)
 895 #define LNET_MT_HASH_MASK               (LNET_MT_HASH_SIZE - 1)
 896 /* we allocate (LNET_MT_HASH_SIZE + 1) entries for lnet_match_table::mt_hash,
 897  * the last entry is reserved for MEs with ignore-bits */
 898 #define LNET_MT_HASH_IGNORE             LNET_MT_HASH_SIZE
 899 /* __u64 has 2^6 bits, so need 2^(LNET_MT_HASH_BITS - LNET_MT_BITS_U64) which
 900  * is 4 __u64s as bit-map, and add an extra __u64 (only use one bit) for the
 901  * ME-list with ignore-bits, which is mtable::mt_hash[LNET_MT_HASH_IGNORE] */
 902 #define LNET_MT_BITS_U64                6       /* 2^6 bits */
 903 #define LNET_MT_EXHAUSTED_BITS          (LNET_MT_HASH_BITS - LNET_MT_BITS_U64)
 904 #define LNET_MT_EXHAUSTED_BMAP          ((1 << LNET_MT_EXHAUSTED_BITS) + 1)
 905
 906 /* portal match table */
 907 struct lnet_match_table {
 908         /* reserved for upcoming patches, CPU partition ID */
 909         unsigned int            mt_cpt;
 910         unsigned int            mt_portal;      /* portal index */
 911         /* match table is set as "enabled" if there's non-exhausted MD
 912          * attached on mt_mhash, it's only valid for wildcard portal */
 913         unsigned int            mt_enabled;
 914         /* bitmap to flag whether MEs on mt_hash are exhausted or not */
 915         __u64                   mt_exhausted[LNET_MT_EXHAUSTED_BMAP];
 916         struct list_head        *mt_mhash;      /* matching hash */
 917 };
 918
 919 /* these are only useful for wildcard portal */
 920 /* Turn off message rotor for wildcard portals */
 921 #define LNET_PTL_ROTOR_OFF      0
 922 /* round-robin dispatch all PUT messages for wildcard portals */
 923 #define LNET_PTL_ROTOR_ON       1
 924 /* round-robin dispatch routed PUT message for wildcard portals */
 925 #define LNET_PTL_ROTOR_RR_RT    2
 926 /* dispatch routed PUT message by hashing source NID for wildcard portals */
 927 #define LNET_PTL_ROTOR_HASH_RT  3
 928
 929 struct lnet_portal {
 930         spinlock_t              ptl_lock;
 931         unsigned int            ptl_index;      /* portal ID, reserved */
 932         /* flags on this portal: lazy, unique... */
 933         unsigned int            ptl_options;
 934         /* list of messages which are stealing buffer */
 935         struct list_head        ptl_msg_stealing;
 936         /* messages blocking for MD */
 937         struct list_head        ptl_msg_delayed;
 938         /* Match table for each CPT */
 939         struct lnet_match_table **ptl_mtables;
 940         /* spread rotor of incoming "PUT" */
 941         unsigned int            ptl_rotor;
 942         /* # active entries for this portal */
 943         int                     ptl_mt_nmaps;
 944         /* array of active entries' cpu-partition-id */
 945         int                     ptl_mt_maps[0];
 946 };
 947
 948 #define LNET_LH_HASH_BITS       12
 949 #define LNET_LH_HASH_SIZE       (1ULL << LNET_LH_HASH_BITS)
 950 #define LNET_LH_HASH_MASK       (LNET_LH_HASH_SIZE - 1)
 951
 952 /* resource container (ME, MD, EQ) */
 953 struct lnet_res_container {
 954         unsigned int            rec_type;       /* container type */
 955         __u64                   rec_lh_cookie;  /* cookie generator */
 956         struct list_head        rec_active;     /* active resource list */
 957         struct list_head        *rec_lh_hash;   /* handle hash */
 958 };
 959
 960 /* message container */
 961 struct lnet_msg_container {
 962         int                     msc_init;       /* initialized or not */
 963         /* max # threads finalizing */
 964         int                     msc_nfinalizers;
 965         /* msgs waiting to complete finalizing */
 966         struct list_head        msc_finalizing;
 967         /* msgs waiting to be resent */
 968         struct list_head        msc_resending;
 969         struct list_head        msc_active;     /* active message list */
 970         /* threads doing finalization */
 971         void                    **msc_finalizers;
 972         /* threads doing resends */
 973         void                    **msc_resenders;
 974 };
 975
 976 /* Peer Discovery states */
 977 #define LNET_DC_STATE_SHUTDOWN          0       /* not started */
 978 #define LNET_DC_STATE_RUNNING           1       /* started up OK */
 979 #define LNET_DC_STATE_STOPPING          2       /* telling thread to stop */
 980
 981 /* Router Checker states */
 982 #define LNET_MT_STATE_SHUTDOWN          0       /* not started */
 983 #define LNET_MT_STATE_RUNNING           1       /* started up OK */
 984 #define LNET_MT_STATE_STOPPING          2       /* telling thread to stop */
 985
 986 /* LNet states */
 987 #define LNET_STATE_SHUTDOWN             0       /* not started */
 988 #define LNET_STATE_RUNNING              1       /* started up OK */
 989 #define LNET_STATE_STOPPING             2       /* telling thread to stop */
 990
 991 struct lnet {
 992         /* CPU partition table of LNet */
 993         struct cfs_cpt_table            *ln_cpt_table;
 994         /* number of CPTs in ln_cpt_table */
 995         unsigned int                    ln_cpt_number;
 996         unsigned int                    ln_cpt_bits;
 997
 998         /* protect LNet resources (ME/MD/EQ) */
 999         struct cfs_percpt_lock          *ln_res_lock;
1000         /* # portals */
1001         int                             ln_nportals;
1002         /* the vector of portals */
1003         struct lnet_portal              **ln_portals;
1004         /* percpt MD container */
1005         struct lnet_res_container       **ln_md_containers;
1006
1007         /* Event Queue container */
1008         struct lnet_res_container       ln_eq_container;
1009         spinlock_t                      ln_eq_wait_lock;
1010
1011         unsigned int                    ln_remote_nets_hbits;
1012
1013         /* protect NI, peer table, credits, routers, rtrbuf... */
1014         struct cfs_percpt_lock          *ln_net_lock;
1015         /* percpt message containers for active/finalizing/freed message */
1016         struct lnet_msg_container       **ln_msg_containers;
1017         struct lnet_counters            **ln_counters;
1018         struct lnet_peer_table          **ln_peer_tables;
1019         /* list of peer nis not on a local network */
1020         struct list_head                ln_remote_peer_ni_list;
1021         /* failure simulation */
1022         struct list_head                ln_test_peers;
1023         struct list_head                ln_drop_rules;
1024         struct list_head                ln_delay_rules;
1025         /* LND instances */
1026         struct list_head                ln_nets;
1027         /* the loopback NI */
1028         struct lnet_ni                  *ln_loni;
1029         /* network zombie list */
1030         struct list_head                ln_net_zombie;
1031         /* resend messages list */
1032         struct list_head                ln_msg_resend;
1033         /* spin lock to protect the msg resend list */
1034         spinlock_t                      ln_msg_resend_lock;
1035
1036         /* remote networks with routes to them */
1037         struct list_head                *ln_remote_nets_hash;
1038         /* validity stamp */
1039         __u64                           ln_remote_nets_version;
1040         /* list of all known routers */
1041         struct list_head                ln_routers;
1042         /* validity stamp */
1043         __u64                           ln_routers_version;
1044         /* percpt router buffer pools */
1045         struct lnet_rtrbufpool          **ln_rtrpools;
1046
1047         /*
1048          * Ping target / Push source
1049          *
1050          * The ping target and push source share a single buffer. The
1051          * ln_ping_target is protected against concurrent updates by
1052          * ln_api_mutex.
1053          */
1054         struct lnet_handle_md           ln_ping_target_md;
1055         lnet_eq_handler_t               ln_ping_target_eq;
1056         struct lnet_ping_buffer         *ln_ping_target;
1057         atomic_t                        ln_ping_target_seqno;
1058
1059         /*
1060          * Push Target
1061          *
1062          * ln_push_nnis contains the desired size of the push target.
1063          * The lnet_net_lock is used to handle update races. The old
1064          * buffer may linger a while after it has been unlinked, in
1065          * which case the event handler cleans up.
1066          */
1067         lnet_eq_handler_t               ln_push_target_eq;
1068         struct lnet_handle_md           ln_push_target_md;
1069         struct lnet_ping_buffer         *ln_push_target;
1070         int                             ln_push_target_nnis;
1071
1072         /* discovery event queue handle */
1073         lnet_eq_handler_t               ln_dc_eq;
1074         /* discovery requests */
1075         struct list_head                ln_dc_request;
1076         /* discovery working list */
1077         struct list_head                ln_dc_working;
1078         /* discovery expired list */
1079         struct list_head                ln_dc_expired;
1080         /* discovery thread wait queue */
1081         wait_queue_head_t               ln_dc_waitq;
1082         /* discovery startup/shutdown state */
1083         int                             ln_dc_state;
1084
1085         /* monitor thread startup/shutdown state */
1086         int                             ln_mt_state;
1087         /* serialise startup/shutdown */
1088         struct semaphore                ln_mt_signal;
1089
1090         struct mutex                    ln_api_mutex;
1091         struct mutex                    ln_lnd_mutex;
1092         /* Have I called LNetNIInit myself? */
1093         int                             ln_niinit_self;
1094         /* LNetNIInit/LNetNIFini counter */
1095         int                             ln_refcount;
1096         /* SHUTDOWN/RUNNING/STOPPING */
1097         int                             ln_state;
1098
1099         int                             ln_routing;     /* am I a router? */
1100         lnet_pid_t                      ln_pid;         /* requested pid */
1101         /* uniquely identifies this ni in this epoch */
1102         __u64                           ln_interface_cookie;
1103         /* registered LNDs */
1104         const struct lnet_lnd           *ln_lnds[NUM_LNDS];
1105
1106         /* test protocol compatibility flags */
1107         unsigned long                   ln_testprotocompat;
1108
1109         /* 0 - load the NIs from the mod params
1110          * 1 - do not load the NIs from the mod params
1111          * Reverse logic to ensure that other calls to LNetNIInit
1112          * need no change
1113          */
1114         bool                            ln_nis_from_mod_params;
1115
1116         /*
1117          * completion for the monitor thread. The monitor thread takes care of
1118          * checking routes, timedout messages and resending messages.
1119          */
1120         struct completion               ln_mt_wait_complete;
1121
1122         /* per-cpt resend queues */
1123         struct list_head                **ln_mt_resendqs;
1124         /* local NIs to recover */
1125         struct list_head                ln_mt_localNIRecovq;
1126         /* local NIs to recover */
1127         struct list_head                ln_mt_peerNIRecovq;
1128         /*
1129          * An array of queues for GET/PUT waiting for REPLY/ACK respectively.
1130          * There are CPT number of queues. Since response trackers will be
1131          * added on the fast path we can't afford to grab the exclusive
1132          * net lock to protect these queues. The CPT will be calculated
1133          * based on the mdh cookie.
1134          */
1135         struct list_head                **ln_mt_rstq;
1136         /*
1137          * A response tracker becomes a zombie when the associated MD is queued
1138          * for unlink before the response tracker is detached from the MD. An
1139          * entry on a zombie list can be freed when either the remaining
1140          * operations on the MD complete or when LNet has shut down.
1141          */
1142         struct list_head                **ln_mt_zombie_rstqs;
1143         /* recovery eq handler */
1144         lnet_eq_handler_t               ln_mt_eq;
1145
1146         /*
1147          * Completed when the discovery and monitor threads can enter their
1148          * work loops
1149          */
1150         struct completion               ln_started;
1151 };
1152
1153 #endif