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