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