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, 2016, 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/types.h>
  48
  49 #include <lnet/lnetctl.h>
  50
  51 /* Max payload size */
  52 #ifndef CONFIG_LNET_MAX_PAYLOAD
  53 # error "CONFIG_LNET_MAX_PAYLOAD must be defined in config.h"
  54 #endif
  55
  56 #define LNET_MAX_PAYLOAD       CONFIG_LNET_MAX_PAYLOAD
  57 #if (LNET_MAX_PAYLOAD < LNET_MTU)
  58 # error "LNET_MAX_PAYLOAD too small - error in configure --with-max-payload-mb"
  59 #elif (LNET_MAX_PAYLOAD > (PAGE_SIZE * LNET_MAX_IOV))
  60 # error "LNET_MAX_PAYLOAD too large - error in configure --with-max-payload-mb"
  61 #endif
  62
  63 /* forward refs */
  64 struct lnet_libmd;
  65
  66 typedef struct lnet_msg {
  67         struct list_head        msg_activelist;
  68         struct list_head        msg_list;       /* Q for credits/MD */
  69
  70         lnet_process_id_t       msg_target;
  71         /* Primary NID of the source. */
  72         lnet_nid_t              msg_initiator;
  73         /* where is it from, it's only for building event */
  74         lnet_nid_t              msg_from;
  75         __u32                   msg_type;
  76
  77         /* committed for sending */
  78         unsigned int            msg_tx_committed:1;
  79         /* CPT # this message committed for sending */
  80         unsigned int            msg_tx_cpt:15;
  81         /* committed for receiving */
  82         unsigned int            msg_rx_committed:1;
  83         /* CPT # this message committed for receiving */
  84         unsigned int            msg_rx_cpt:15;
  85         /* queued for tx credit */
  86         unsigned int            msg_tx_delayed:1;
  87         /* queued for RX buffer */
  88         unsigned int            msg_rx_delayed:1;
  89         /* ready for pending on RX delay list */
  90         unsigned int            msg_rx_ready_delay:1;
  91
  92         unsigned int          msg_vmflush:1;      /* VM trying to free memory */
  93         unsigned int          msg_target_is_router:1; /* sending to a router */
  94         unsigned int          msg_routing:1;      /* being forwarded */
  95         unsigned int          msg_ack:1;          /* ack on finalize (PUT) */
  96         unsigned int          msg_sending:1;      /* outgoing message */
  97         unsigned int          msg_receiving:1;    /* being received */
  98         unsigned int          msg_txcredit:1;     /* taken an NI send credit */
  99         unsigned int          msg_peertxcredit:1; /* taken a peer send credit */
 100         unsigned int          msg_rtrcredit:1;    /* taken a globel router credit */
 101         unsigned int          msg_peerrtrcredit:1; /* taken a peer router credit */
 102         unsigned int          msg_onactivelist:1; /* on the activelist */
 103         unsigned int          msg_rdma_get:1;
 104
 105         struct lnet_peer_ni  *msg_txpeer;         /* peer I'm sending to */
 106         struct lnet_peer_ni  *msg_rxpeer;         /* peer I received from */
 107
 108         void                 *msg_private;
 109         struct lnet_libmd    *msg_md;
 110         /* the NI the message was sent or received over */
 111         struct lnet_ni       *msg_txni;
 112         struct lnet_ni       *msg_rxni;
 113
 114         unsigned int          msg_len;
 115         unsigned int          msg_wanted;
 116         unsigned int          msg_offset;
 117         unsigned int          msg_niov;
 118         struct kvec          *msg_iov;
 119         lnet_kiov_t          *msg_kiov;
 120
 121         lnet_event_t          msg_ev;
 122         lnet_hdr_t            msg_hdr;
 123 } lnet_msg_t;
 124
 125
 126 typedef struct lnet_libhandle {
 127         struct list_head        lh_hash_chain;
 128         __u64                   lh_cookie;
 129 } lnet_libhandle_t;
 130
 131 #define lh_entry(ptr, type, member) \
 132         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
 133
 134 typedef struct lnet_eq {
 135         struct list_head        eq_list;
 136         lnet_libhandle_t        eq_lh;
 137         lnet_seq_t              eq_enq_seq;
 138         lnet_seq_t              eq_deq_seq;
 139         unsigned int            eq_size;
 140         lnet_eq_handler_t       eq_callback;
 141         lnet_event_t            *eq_events;
 142         int                     **eq_refs;      /* percpt refcount for EQ */
 143 } lnet_eq_t;
 144
 145 typedef struct lnet_me {
 146         struct list_head        me_list;
 147         lnet_libhandle_t        me_lh;
 148         lnet_process_id_t       me_match_id;
 149         unsigned int            me_portal;
 150         unsigned int            me_pos;         /* hash offset in mt_hash */
 151         __u64                   me_match_bits;
 152         __u64                   me_ignore_bits;
 153         lnet_unlink_t           me_unlink;
 154         struct lnet_libmd      *me_md;
 155 } lnet_me_t;
 156
 157 typedef struct lnet_libmd {
 158         struct list_head        md_list;
 159         lnet_libhandle_t        md_lh;
 160         lnet_me_t              *md_me;
 161         char                   *md_start;
 162         unsigned int            md_offset;
 163         unsigned int            md_length;
 164         unsigned int            md_max_size;
 165         int                     md_threshold;
 166         int                     md_refcount;
 167         unsigned int            md_options;
 168         unsigned int            md_flags;
 169         unsigned int            md_niov;        /* # frags at end of struct */
 170         void                   *md_user_ptr;
 171         lnet_eq_t              *md_eq;
 172         union {
 173                 struct kvec     iov[LNET_MAX_IOV];
 174                 lnet_kiov_t     kiov[LNET_MAX_IOV];
 175         } md_iov;
 176 } lnet_libmd_t;
 177
 178 #define LNET_MD_FLAG_ZOMBIE      (1 << 0)
 179 #define LNET_MD_FLAG_AUTO_UNLINK (1 << 1)
 180 #define LNET_MD_FLAG_ABORTED     (1 << 2)
 181
 182 typedef struct {
 183         /* info about peers we are trying to fail */
 184         struct list_head        tp_list;        /* ln_test_peers */
 185         lnet_nid_t              tp_nid;         /* matching nid */
 186         unsigned int            tp_threshold;   /* # failures to simulate */
 187 } lnet_test_peer_t;
 188
 189 #define LNET_COOKIE_TYPE_MD    1
 190 #define LNET_COOKIE_TYPE_ME    2
 191 #define LNET_COOKIE_TYPE_EQ    3
 192 #define LNET_COOKIE_TYPE_BITS  2
 193 #define LNET_COOKIE_MASK        ((1ULL << LNET_COOKIE_TYPE_BITS) - 1ULL)
 194
 195 struct lnet_ni;                                  /* forward ref */
 196 struct socket;
 197
 198 typedef struct lnet_lnd
 199 {
 200         /* fields managed by portals */
 201         struct list_head        lnd_list;       /* stash in the LND table */
 202         int                     lnd_refcount;   /* # active instances */
 203
 204         /* fields initialized by the LND */
 205         __u32                   lnd_type;
 206
 207         int  (*lnd_startup)(struct lnet_ni *ni);
 208         void (*lnd_shutdown)(struct lnet_ni *ni);
 209         int  (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
 210
 211         /* In data movement APIs below, payload buffers are described as a set
 212          * of 'niov' fragments which are...
 213          * EITHER
 214          *    in virtual memory (struct kvec *iov != NULL)
 215          * OR
 216          *    in pages (kernel only: plt_kiov_t *kiov != NULL).
 217          * The LND may NOT overwrite these fragment descriptors.
 218          * An 'offset' and may specify a byte offset within the set of
 219          * fragments to start from
 220          */
 221
 222         /* Start sending a preformatted message.  'private' is NULL for PUT and
 223          * GET messages; otherwise this is a response to an incoming message
 224          * and 'private' is the 'private' passed to lnet_parse().  Return
 225          * non-zero for immediate failure, otherwise complete later with
 226          * lnet_finalize() */
 227         int (*lnd_send)(struct lnet_ni *ni, void *private, lnet_msg_t *msg);
 228
 229         /* Start receiving 'mlen' bytes of payload data, skipping the following
 230          * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
 231          * lnet_parse().  Return non-zero for immedaite failure, otherwise
 232          * complete later with lnet_finalize().  This also gives back a receive
 233          * credit if the LND does flow control. */
 234         int (*lnd_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
 235                         int delayed, unsigned int niov,
 236                         struct kvec *iov, lnet_kiov_t *kiov,
 237                         unsigned int offset, unsigned int mlen, unsigned int rlen);
 238
 239         /* lnet_parse() has had to delay processing of this message
 240          * (e.g. waiting for a forwarding buffer or send credits).  Give the
 241          * LND a chance to free urgently needed resources.  If called, return 0
 242          * for success and do NOT give back a receive credit; that has to wait
 243          * until lnd_recv() gets called.  On failure return < 0 and
 244          * release resources; lnd_recv() will not be called. */
 245         int (*lnd_eager_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
 246                               void **new_privatep);
 247
 248         /* notification of peer health */
 249         void (*lnd_notify)(struct lnet_ni *ni, lnet_nid_t peer, int alive);
 250
 251         /* query of peer aliveness */
 252         void (*lnd_query)(struct lnet_ni *ni, lnet_nid_t peer, cfs_time_t *when);
 253
 254         /* accept a new connection */
 255         int (*lnd_accept)(struct lnet_ni *ni, struct socket *sock);
 256 } lnd_t;
 257
 258 typedef struct lnet_ni_status {
 259         lnet_nid_t ns_nid;
 260         __u32      ns_status;
 261         __u32      ns_unused;
 262 } WIRE_ATTR lnet_ni_status_t;
 263
 264 struct lnet_tx_queue {
 265         int                     tq_credits;     /* # tx credits free */
 266         int                     tq_credits_min; /* lowest it's been */
 267         int                     tq_credits_max; /* total # tx credits */
 268         struct list_head        tq_delayed;     /* delayed TXs */
 269 };
 270
 271 enum lnet_net_state {
 272         /* set when net block is allocated */
 273         LNET_NET_STATE_INIT = 0,
 274         /* set when NIs in net are started successfully */
 275         LNET_NET_STATE_ACTIVE,
 276         /* set if all NIs in net are in FAILED state */
 277         LNET_NET_STATE_INACTIVE,
 278         /* set when shutting down a NET */
 279         LNET_NET_STATE_DELETING
 280 };
 281
 282 enum lnet_ni_state {
 283         /* set when NI block is allocated */
 284         LNET_NI_STATE_INIT = 0,
 285         /* set when NI is started successfully */
 286         LNET_NI_STATE_ACTIVE,
 287         /* set when LND notifies NI failed */
 288         LNET_NI_STATE_FAILED,
 289         /* set when LND notifies NI degraded */
 290         LNET_NI_STATE_DEGRADED,
 291         /* set when shuttding down NI */
 292         LNET_NI_STATE_DELETING
 293 };
 294
 295 struct lnet_element_stats {
 296         atomic_t        send_count;
 297         atomic_t        recv_count;
 298         atomic_t        drop_count;
 299 };
 300
 301 struct lnet_net {
 302         /* chain on the ln_nets */
 303         struct list_head        net_list;
 304
 305         /* net ID, which is composed of
 306          * (net_type << 16) | net_num.
 307          * net_type can be one of the enumerated types defined in
 308          * lnet/include/lnet/nidstr.h */
 309         __u32                   net_id;
 310
 311         /* priority of the network */
 312         __u32                   net_prio;
 313
 314         /* total number of CPTs in the array */
 315         __u32                   net_ncpts;
 316
 317         /* cumulative CPTs of all NIs in this net */
 318         __u32                   *net_cpts;
 319
 320         /* network tunables */
 321         struct lnet_ioctl_config_lnd_cmn_tunables net_tunables;
 322
 323         /*
 324          * boolean to indicate that the tunables have been set and
 325          * shouldn't be reset
 326          */
 327         bool                    net_tunables_set;
 328
 329         /* procedural interface */
 330         lnd_t                   *net_lnd;
 331
 332         /* list of NIs on this net */
 333         struct list_head        net_ni_list;
 334
 335         /* list of NIs being added, but not started yet */
 336         struct list_head        net_ni_added;
 337
 338         /* dying LND instances */
 339         struct list_head        net_ni_zombie;
 340
 341         /* network state */
 342         enum lnet_net_state     net_state;
 343 };
 344
 345 typedef struct lnet_ni {
 346         /* chain on the lnet_net structure */
 347         struct list_head        ni_netlist;
 348
 349         /* chain on net_ni_cpt */
 350         struct list_head        ni_cptlist;
 351
 352         spinlock_t              ni_lock;
 353
 354         /* number of CPTs */
 355         int                     ni_ncpts;
 356
 357         /* bond NI on some CPTs */
 358         __u32                   *ni_cpts;
 359
 360         /* interface's NID */
 361         lnet_nid_t              ni_nid;
 362
 363         /* instance-specific data */
 364         void                    *ni_data;
 365
 366         /* per ni credits */
 367         atomic_t                ni_tx_credits;
 368
 369         /* percpt TX queues */
 370         struct lnet_tx_queue    **ni_tx_queues;
 371
 372         /* percpt reference count */
 373         int                     **ni_refs;
 374
 375         /* when I was last alive */
 376         long                    ni_last_alive;
 377
 378         /* pointer to parent network */
 379         struct lnet_net         *ni_net;
 380
 381         /* my health status */
 382         lnet_ni_status_t        *ni_status;
 383
 384         /* NI FSM */
 385         enum lnet_ni_state      ni_state;
 386
 387         /* per NI LND tunables */
 388         struct lnet_lnd_tunables ni_lnd_tunables;
 389
 390         /* lnd tunables set explicitly */
 391         bool ni_lnd_tunables_set;
 392
 393         /* NI statistics */
 394         struct lnet_element_stats ni_stats;
 395
 396         /* physical device CPT */
 397         int                     dev_cpt;
 398
 399         /* sequence number used to round robin over nis within a net */
 400         __u32                   ni_seq;
 401
 402         /*
 403          * equivalent interfaces to use
 404          * This is an array because socklnd bonding can still be configured
 405          */
 406         char                    *ni_interfaces[LNET_MAX_INTERFACES];
 407         struct net              *ni_net_ns;     /* original net namespace */
 408 } lnet_ni_t;
 409
 410 #define LNET_PROTO_PING_MATCHBITS       0x8000000000000000LL
 411
 412 /* NB: value of these features equal to LNET_PROTO_PING_VERSION_x
 413  * of old LNet, so there shouldn't be any compatibility issue */
 414 #define LNET_PING_FEAT_INVAL            (0)             /* no feature */
 415 #define LNET_PING_FEAT_BASE             (1 << 0)        /* just a ping */
 416 #define LNET_PING_FEAT_NI_STATUS        (1 << 1)        /* return NI status */
 417 #define LNET_PING_FEAT_RTE_DISABLED     (1 << 2)        /* Routing enabled */
 418
 419 #define LNET_PING_FEAT_MASK             (LNET_PING_FEAT_BASE | \
 420                                          LNET_PING_FEAT_NI_STATUS)
 421
 422 typedef struct lnet_ping_info {
 423         __u32                   pi_magic;
 424         __u32                   pi_features;
 425         lnet_pid_t              pi_pid;
 426         __u32                   pi_nnis;
 427         struct lnet_ni_status   pi_ni[0];
 428 } WIRE_ATTR lnet_ping_info_t;
 429
 430 /* router checker data, per router */
 431 #define LNET_MAX_RTR_NIS   16
 432 #define LNET_PINGINFO_SIZE offsetof(struct lnet_ping_info, pi_ni[LNET_MAX_RTR_NIS])
 433 typedef struct {
 434         /* chain on the_lnet.ln_zombie_rcd or ln_deathrow_rcd */
 435         struct list_head        rcd_list;
 436         lnet_handle_md_t        rcd_mdh;        /* ping buffer MD */
 437         struct lnet_peer_ni     *rcd_gateway;   /* reference to gateway */
 438         struct lnet_ping_info   *rcd_pinginfo;  /* ping buffer */
 439 } lnet_rc_data_t;
 440
 441 struct lnet_peer_ni {
 442         /* chain on peer_net */
 443         struct list_head        lpni_on_peer_net_list;
 444         /* chain on remote peer list */
 445         struct list_head        lpni_on_remote_peer_ni_list;
 446         /* chain on peer hash */
 447         struct list_head        lpni_hashlist;
 448         /* messages blocking for tx credits */
 449         struct list_head        lpni_txq;
 450         /* messages blocking for router credits */
 451         struct list_head        lpni_rtrq;
 452         /* chain on router list */
 453         struct list_head        lpni_rtr_list;
 454         /* pointer to peer net I'm part of */
 455         struct lnet_peer_net    *lpni_peer_net;
 456         /* statistics kept on each peer NI */
 457         struct lnet_element_stats lpni_stats;
 458         /* spin lock protecting credits and lpni_txq / lpni_rtrq */
 459         spinlock_t              lpni_lock;
 460         /* # tx credits available */
 461         int                     lpni_txcredits;
 462         /* low water mark */
 463         int                     lpni_mintxcredits;
 464         /* # router credits */
 465         int                     lpni_rtrcredits;
 466         /* low water mark */
 467         int                     lpni_minrtrcredits;
 468         /* alive/dead? */
 469         bool                    lpni_alive;
 470         /* notification outstanding? */
 471         bool                    lpni_notify;
 472         /* outstanding notification for LND? */
 473         bool                    lpni_notifylnd;
 474         /* some thread is handling notification */
 475         bool                    lpni_notifying;
 476         /* SEND event outstanding from ping */
 477         bool                    lpni_ping_notsent;
 478         /* # times router went dead<->alive. Protected with lpni_lock */
 479         int                     lpni_alive_count;
 480         /* bytes queued for sending */
 481         long                    lpni_txqnob;
 482         /* time of last aliveness news */
 483         cfs_time_t              lpni_timestamp;
 484         /* time of last ping attempt */
 485         cfs_time_t              lpni_ping_timestamp;
 486         /* != 0 if ping reply expected */
 487         cfs_time_t              lpni_ping_deadline;
 488         /* when I was last alive */
 489         cfs_time_t              lpni_last_alive;
 490         /* when lpni_ni was queried last time */
 491         cfs_time_t              lpni_last_query;
 492         /* network peer is on */
 493         struct lnet_net         *lpni_net;
 494         /* peer's NID */
 495         lnet_nid_t              lpni_nid;
 496         /* # refs */
 497         atomic_t                lpni_refcount;
 498         /* CPT this peer attached on */
 499         int                     lpni_cpt;
 500         /* # refs from lnet_route_t::lr_gateway */
 501         int                     lpni_rtr_refcount;
 502         /* sequence number used to round robin over peer nis within a net */
 503         __u32                   lpni_seq;
 504         /* health flag */
 505         bool                    lpni_healthy;
 506         /* returned RC ping features. Protected with lpni_lock */
 507         unsigned int            lpni_ping_feats;
 508         /* routes on this peer */
 509         struct list_head        lpni_routes;
 510         /* array of preferred local nids */
 511         lnet_nid_t              *lpni_pref_nids;
 512         /* number of preferred NIDs in lnpi_pref_nids */
 513         __u32                   lpni_pref_nnids;
 514         /* router checker state */
 515         lnet_rc_data_t          *lpni_rcd;
 516 };
 517
 518 struct lnet_peer {
 519         /* chain on global peer list */
 520         struct list_head        lp_on_lnet_peer_list;
 521
 522         /* list of peer nets */
 523         struct list_head        lp_peer_nets;
 524
 525         /* primary NID of the peer */
 526         lnet_nid_t              lp_primary_nid;
 527
 528         /* peer is Multi-Rail enabled peer */
 529         bool                    lp_multi_rail;
 530 };
 531
 532 struct lnet_peer_net {
 533         /* chain on peer block */
 534         struct list_head        lpn_on_peer_list;
 535
 536         /* list of peer_nis on this network */
 537         struct list_head        lpn_peer_nis;
 538
 539         /* pointer to the peer I'm part of */
 540         struct lnet_peer        *lpn_peer;
 541
 542         /* Net ID */
 543         __u32                   lpn_net_id;
 544
 545         /* health flag */
 546         bool                    lpn_healthy;
 547 };
 548
 549 /* peer hash size */
 550 #define LNET_PEER_HASH_BITS     9
 551 #define LNET_PEER_HASH_SIZE     (1 << LNET_PEER_HASH_BITS)
 552
 553 /* peer hash table */
 554 struct lnet_peer_table {
 555         int                     pt_version;     /* /proc validity stamp */
 556         atomic_t                pt_number;      /* # peers extant */
 557         struct list_head        *pt_hash;       /* NID->peer hash */
 558         struct list_head        pt_zombie_list; /* zombie peers */
 559         int                     pt_zombies;     /* # zombie peers */
 560         spinlock_t              pt_zombie_lock; /* protect list and count */
 561 };
 562
 563 /* peer aliveness is enabled only on routers for peers in a network where the
 564  * lnet_ni_t::ni_peertimeout has been set to a positive value */
 565 #define lnet_peer_aliveness_enabled(lp) (the_lnet.ln_routing != 0 && \
 566                                          (lp)->lpni_net->net_tunables.lct_peer_timeout > 0)
 567
 568 typedef struct {
 569         struct list_head        lr_list;        /* chain on net */
 570         struct list_head        lr_gwlist;      /* chain on gateway */
 571         struct lnet_peer_ni     *lr_gateway;    /* router node */
 572         __u32                   lr_net;         /* remote network number */
 573         int                     lr_seq;         /* sequence for round-robin */
 574         unsigned int            lr_downis;      /* number of down NIs */
 575         __u32                   lr_hops;        /* how far I am */
 576         unsigned int            lr_priority;    /* route priority */
 577 } lnet_route_t;
 578
 579 #define LNET_REMOTE_NETS_HASH_DEFAULT   (1U << 7)
 580 #define LNET_REMOTE_NETS_HASH_MAX       (1U << 16)
 581 #define LNET_REMOTE_NETS_HASH_SIZE      (1 << the_lnet.ln_remote_nets_hbits)
 582
 583 typedef struct {
 584         /* chain on ln_remote_nets_hash */
 585         struct list_head        lrn_list;
 586         /* routes to me */
 587         struct list_head        lrn_routes;
 588         /* my net number */
 589         __u32                   lrn_net;
 590 } lnet_remotenet_t;
 591
 592 /** lnet message has credit and can be submitted to lnd for send/receive */
 593 #define LNET_CREDIT_OK          0
 594 /** lnet message is waiting for credit */
 595 #define LNET_CREDIT_WAIT        1
 596
 597 typedef struct {
 598         /* my free buffer pool */
 599         struct list_head        rbp_bufs;
 600         /* messages blocking for a buffer */
 601         struct list_head        rbp_msgs;
 602         /* # pages in each buffer */
 603         int                     rbp_npages;
 604         /* requested number of buffers */
 605         int                     rbp_req_nbuffers;
 606         /* # buffers actually allocated */
 607         int                     rbp_nbuffers;
 608         /* # free buffers / blocked messages */
 609         int                     rbp_credits;
 610         /* low water mark */
 611         int                     rbp_mincredits;
 612 } lnet_rtrbufpool_t;
 613
 614 typedef struct {
 615         struct list_head         rb_list;       /* chain on rbp_bufs */
 616         lnet_rtrbufpool_t       *rb_pool;       /* owning pool */
 617         lnet_kiov_t              rb_kiov[0];    /* the buffer space */
 618 } lnet_rtrbuf_t;
 619
 620 #define LNET_PEER_HASHSIZE   503                /* prime! */
 621
 622 enum {
 623         /* Didn't match anything */
 624         LNET_MATCHMD_NONE       = (1 << 0),
 625         /* Matched OK */
 626         LNET_MATCHMD_OK         = (1 << 1),
 627         /* Must be discarded */
 628         LNET_MATCHMD_DROP       = (1 << 2),
 629         /* match and buffer is exhausted */
 630         LNET_MATCHMD_EXHAUSTED  = (1 << 3),
 631         /* match or drop */
 632         LNET_MATCHMD_FINISH     = (LNET_MATCHMD_OK | LNET_MATCHMD_DROP),
 633 };
 634
 635 /* Options for lnet_portal_t::ptl_options */
 636 #define LNET_PTL_LAZY               (1 << 0)
 637 #define LNET_PTL_MATCH_UNIQUE       (1 << 1)    /* unique match, for RDMA */
 638 #define LNET_PTL_MATCH_WILDCARD     (1 << 2)    /* wildcard match, request portal */
 639
 640 /* parameter for matching operations (GET, PUT) */
 641 struct lnet_match_info {
 642         __u64                   mi_mbits;
 643         lnet_process_id_t       mi_id;
 644         unsigned int            mi_cpt;
 645         unsigned int            mi_opc;
 646         unsigned int            mi_portal;
 647         unsigned int            mi_rlength;
 648         unsigned int            mi_roffset;
 649 };
 650
 651 /* ME hash of RDMA portal */
 652 #define LNET_MT_HASH_BITS               8
 653 #define LNET_MT_HASH_SIZE               (1 << LNET_MT_HASH_BITS)
 654 #define LNET_MT_HASH_MASK               (LNET_MT_HASH_SIZE - 1)
 655 /* we allocate (LNET_MT_HASH_SIZE + 1) entries for lnet_match_table::mt_hash,
 656  * the last entry is reserved for MEs with ignore-bits */
 657 #define LNET_MT_HASH_IGNORE             LNET_MT_HASH_SIZE
 658 /* __u64 has 2^6 bits, so need 2^(LNET_MT_HASH_BITS - LNET_MT_BITS_U64) which
 659  * is 4 __u64s as bit-map, and add an extra __u64 (only use one bit) for the
 660  * ME-list with ignore-bits, which is mtable::mt_hash[LNET_MT_HASH_IGNORE] */
 661 #define LNET_MT_BITS_U64                6       /* 2^6 bits */
 662 #define LNET_MT_EXHAUSTED_BITS          (LNET_MT_HASH_BITS - LNET_MT_BITS_U64)
 663 #define LNET_MT_EXHAUSTED_BMAP          ((1 << LNET_MT_EXHAUSTED_BITS) + 1)
 664
 665 /* portal match table */
 666 struct lnet_match_table {
 667         /* reserved for upcoming patches, CPU partition ID */
 668         unsigned int            mt_cpt;
 669         unsigned int            mt_portal;      /* portal index */
 670         /* match table is set as "enabled" if there's non-exhausted MD
 671          * attached on mt_mhash, it's only valid for wildcard portal */
 672         unsigned int            mt_enabled;
 673         /* bitmap to flag whether MEs on mt_hash are exhausted or not */
 674         __u64                   mt_exhausted[LNET_MT_EXHAUSTED_BMAP];
 675         struct list_head        *mt_mhash;      /* matching hash */
 676 };
 677
 678 /* these are only useful for wildcard portal */
 679 /* Turn off message rotor for wildcard portals */
 680 #define LNET_PTL_ROTOR_OFF      0
 681 /* round-robin dispatch all PUT messages for wildcard portals */
 682 #define LNET_PTL_ROTOR_ON       1
 683 /* round-robin dispatch routed PUT message for wildcard portals */
 684 #define LNET_PTL_ROTOR_RR_RT    2
 685 /* dispatch routed PUT message by hashing source NID for wildcard portals */
 686 #define LNET_PTL_ROTOR_HASH_RT  3
 687
 688 typedef struct lnet_portal {
 689         spinlock_t              ptl_lock;
 690         unsigned int            ptl_index;      /* portal ID, reserved */
 691         /* flags on this portal: lazy, unique... */
 692         unsigned int            ptl_options;
 693         /* list of messages which are stealing buffer */
 694         struct list_head        ptl_msg_stealing;
 695         /* messages blocking for MD */
 696         struct list_head        ptl_msg_delayed;
 697         /* Match table for each CPT */
 698         struct lnet_match_table **ptl_mtables;
 699         /* spread rotor of incoming "PUT" */
 700         unsigned int            ptl_rotor;
 701         /* # active entries for this portal */
 702         int                     ptl_mt_nmaps;
 703         /* array of active entries' cpu-partition-id */
 704         int                     ptl_mt_maps[0];
 705 } lnet_portal_t;
 706
 707 #define LNET_LH_HASH_BITS       12
 708 #define LNET_LH_HASH_SIZE       (1ULL << LNET_LH_HASH_BITS)
 709 #define LNET_LH_HASH_MASK       (LNET_LH_HASH_SIZE - 1)
 710
 711 /* resource container (ME, MD, EQ) */
 712 struct lnet_res_container {
 713         unsigned int            rec_type;       /* container type */
 714         __u64                   rec_lh_cookie;  /* cookie generator */
 715         struct list_head        rec_active;     /* active resource list */
 716         struct list_head        *rec_lh_hash;   /* handle hash */
 717 };
 718
 719 /* message container */
 720 struct lnet_msg_container {
 721         int                     msc_init;       /* initialized or not */
 722         /* max # threads finalizing */
 723         int                     msc_nfinalizers;
 724         /* msgs waiting to complete finalizing */
 725         struct list_head        msc_finalizing;
 726         struct list_head        msc_active;     /* active message list */
 727         /* threads doing finalization */
 728         void                    **msc_finalizers;
 729 };
 730
 731 /* Router Checker states */
 732 #define LNET_RC_STATE_SHUTDOWN          0       /* not started */
 733 #define LNET_RC_STATE_RUNNING           1       /* started up OK */
 734 #define LNET_RC_STATE_STOPPING          2       /* telling thread to stop */
 735
 736 typedef struct
 737 {
 738         /* CPU partition table of LNet */
 739         struct cfs_cpt_table            *ln_cpt_table;
 740         /* number of CPTs in ln_cpt_table */
 741         unsigned int                    ln_cpt_number;
 742         unsigned int                    ln_cpt_bits;
 743
 744         /* protect LNet resources (ME/MD/EQ) */
 745         struct cfs_percpt_lock          *ln_res_lock;
 746         /* # portals */
 747         int                             ln_nportals;
 748         /* the vector of portals */
 749         lnet_portal_t                   **ln_portals;
 750         /* percpt ME containers */
 751         struct lnet_res_container       **ln_me_containers;
 752         /* percpt MD container */
 753         struct lnet_res_container       **ln_md_containers;
 754
 755         /* Event Queue container */
 756         struct lnet_res_container       ln_eq_container;
 757         wait_queue_head_t               ln_eq_waitq;
 758         spinlock_t                      ln_eq_wait_lock;
 759
 760         unsigned int                    ln_remote_nets_hbits;
 761
 762         /* protect NI, peer table, credits, routers, rtrbuf... */
 763         struct cfs_percpt_lock          *ln_net_lock;
 764         /* percpt message containers for active/finalizing/freed message */
 765         struct lnet_msg_container       **ln_msg_containers;
 766         lnet_counters_t                 **ln_counters;
 767         struct lnet_peer_table          **ln_peer_tables;
 768         /* list of configured or discovered peers */
 769         struct list_head                ln_peers;
 770         /* list of peer nis not on a local network */
 771         struct list_head                ln_remote_peer_ni_list;
 772         /* failure simulation */
 773         struct list_head                ln_test_peers;
 774         struct list_head                ln_drop_rules;
 775         struct list_head                ln_delay_rules;
 776         /* LND instances */
 777         struct list_head                ln_nets;
 778         /* the loopback NI */
 779         struct lnet_ni                  *ln_loni;
 780         /* network zombie list */
 781         struct list_head                ln_net_zombie;
 782
 783         /* remote networks with routes to them */
 784         struct list_head                *ln_remote_nets_hash;
 785         /* validity stamp */
 786         __u64                           ln_remote_nets_version;
 787         /* list of all known routers */
 788         struct list_head                ln_routers;
 789         /* validity stamp */
 790         __u64                           ln_routers_version;
 791         /* percpt router buffer pools */
 792         lnet_rtrbufpool_t               **ln_rtrpools;
 793
 794         lnet_handle_md_t                ln_ping_target_md;
 795         lnet_handle_eq_t                ln_ping_target_eq;
 796         struct lnet_ping_info           *ln_ping_info;
 797
 798         /* router checker startup/shutdown state */
 799         int                             ln_rc_state;
 800         /* router checker's event queue */
 801         lnet_handle_eq_t                ln_rc_eqh;
 802         /* rcd still pending on net */
 803         struct list_head                ln_rcd_deathrow;
 804         /* rcd ready for free */
 805         struct list_head                ln_rcd_zombie;
 806         /* serialise startup/shutdown */
 807         struct semaphore                ln_rc_signal;
 808
 809         struct mutex                    ln_api_mutex;
 810         struct mutex                    ln_lnd_mutex;
 811         /* Have I called LNetNIInit myself? */
 812         int                             ln_niinit_self;
 813         /* LNetNIInit/LNetNIFini counter */
 814         int                             ln_refcount;
 815         /* shutdown in progress */
 816         int                             ln_shutdown;
 817
 818         int                             ln_routing;     /* am I a router? */
 819         lnet_pid_t                      ln_pid;         /* requested pid */
 820         /* uniquely identifies this ni in this epoch */
 821         __u64                           ln_interface_cookie;
 822         /* registered LNDs */
 823         struct list_head                ln_lnds;
 824
 825         /* test protocol compatibility flags */
 826         int                             ln_testprotocompat;
 827
 828         /* 0 - load the NIs from the mod params
 829          * 1 - do not load the NIs from the mod params
 830          * Reverse logic to ensure that other calls to LNetNIInit
 831          * need no change
 832          */
 833         bool                            ln_nis_from_mod_params;
 834
 835         /* waitq for router checker.  As long as there are no routes in
 836          * the list, the router checker will sleep on this queue.  when
 837          * routes are added the thread will wake up */
 838         wait_queue_head_t               ln_rc_waitq;
 839 } lnet_t;
 840
 841 #endif