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