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