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