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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  */
  30 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  *
  34  * lnet/include/lnet/lib-types.h
  35  *
  36  * Types used by the library side routines that do not need to be
  37  * exposed to the user application
  38  */
  39
  40 #ifndef __LNET_LIB_TYPES_H__
  41 #define __LNET_LIB_TYPES_H__
  42
  43 #if defined(__linux__)
  44 #include <lnet/linux/lib-types.h>
  45 #elif defined(__APPLE__)
  46 #include <lnet/darwin/lib-types.h>
  47 #elif defined(__WINNT__)
  48 #include <lnet/winnt/lib-types.h>
  49 #else
  50 #error Unsupported Operating System
  51 #endif
  52
  53 #include <libcfs/libcfs.h>
  54 #include <libcfs/list.h>
  55 #include <lnet/types.h>
  56
  57 #define WIRE_ATTR       __attribute__((packed))
  58
  59 /* Packed version of lnet_process_id_t to transfer via network */
  60 #include <libcfs/libcfs_pack.h>
  61 typedef struct {
  62         lnet_nid_t nid;
  63         lnet_pid_t pid;   /* node id / process id */
  64 } WIRE_ATTR lnet_process_id_packed_t;
  65
  66 /* The wire handle's interface cookie only matches one network interface in
  67  * one epoch (i.e. new cookie when the interface restarts or the node
  68  * reboots).  The object cookie only matches one object on that interface
  69  * during that object's lifetime (i.e. no cookie re-use). */
  70 typedef struct {
  71         __u64 wh_interface_cookie;
  72         __u64 wh_object_cookie;
  73 } WIRE_ATTR lnet_handle_wire_t;
  74 #include <libcfs/libcfs_unpack.h>
  75
  76 typedef enum {
  77         LNET_MSG_ACK = 0,
  78         LNET_MSG_PUT,
  79         LNET_MSG_GET,
  80         LNET_MSG_REPLY,
  81         LNET_MSG_HELLO,
  82 } lnet_msg_type_t;
  83
  84 /* The variant fields of the portals message header are aligned on an 8
  85  * byte boundary in the message header.  Note that all types used in these
  86  * wire structs MUST be fixed size and the smaller types are placed at the
  87  * end. */
  88 #include <libcfs/libcfs_pack.h>
  89 typedef struct lnet_ack {
  90         lnet_handle_wire_t  dst_wmd;
  91         __u64               match_bits;
  92         __u32               mlength;
  93 } WIRE_ATTR lnet_ack_t;
  94
  95 typedef struct lnet_put {
  96         lnet_handle_wire_t  ack_wmd;
  97         __u64               match_bits;
  98         __u64               hdr_data;
  99         __u32               ptl_index;
 100         __u32               offset;
 101 } WIRE_ATTR lnet_put_t;
 102
 103 typedef struct lnet_get {
 104         lnet_handle_wire_t  return_wmd;
 105         __u64               match_bits;
 106         __u32               ptl_index;
 107         __u32               src_offset;
 108         __u32               sink_length;
 109 } WIRE_ATTR lnet_get_t;
 110
 111 typedef struct lnet_reply {
 112         lnet_handle_wire_t  dst_wmd;
 113 } WIRE_ATTR lnet_reply_t;
 114
 115 typedef struct lnet_hello {
 116         __u64              incarnation;
 117         __u32              type;
 118 } WIRE_ATTR lnet_hello_t;
 119
 120 typedef struct {
 121         lnet_nid_t          dest_nid;
 122         lnet_nid_t          src_nid;
 123         lnet_pid_t          dest_pid;
 124         lnet_pid_t          src_pid;
 125         __u32               type;               /* lnet_msg_type_t */
 126         __u32               payload_length;     /* payload data to follow */
 127         /*<------__u64 aligned------->*/
 128         union {
 129                 lnet_ack_t   ack;
 130                 lnet_put_t   put;
 131                 lnet_get_t   get;
 132                 lnet_reply_t reply;
 133                 lnet_hello_t hello;
 134         } msg;
 135 } WIRE_ATTR lnet_hdr_t;
 136
 137 /* A HELLO message contains a magic number and protocol version
 138  * code in the header's dest_nid, the peer's NID in the src_nid, and
 139  * LNET_MSG_HELLO in the type field.  All other common fields are zero
 140  * (including payload_size; i.e. no payload).
 141  * This is for use by byte-stream LNDs (e.g. TCP/IP) to check the peer is
 142  * running the same protocol and to find out its NID. These LNDs should
 143  * exchange HELLO messages when a connection is first established.  Individual
 144  * LNDs can put whatever else they fancy in lnet_hdr_t::msg.
 145  */
 146 typedef struct {
 147         __u32   magic;                          /* LNET_PROTO_TCP_MAGIC */
 148         __u16   version_major;                  /* increment on incompatible change */
 149         __u16   version_minor;                  /* increment on compatible change */
 150 } WIRE_ATTR lnet_magicversion_t;
 151
 152 /* PROTO MAGIC for LNDs */
 153 #define LNET_PROTO_IB_MAGIC                 0x0be91b91
 154 #define LNET_PROTO_RA_MAGIC                 0x0be91b92
 155 #define LNET_PROTO_QSW_MAGIC                0x0be91b93
 156 #define LNET_PROTO_GNI_MAGIC                0xb00fbabe /* ask Kim */
 157 #define LNET_PROTO_TCP_MAGIC                0xeebc0ded
 158 #define LNET_PROTO_PTL_MAGIC                0x50746C4E /* 'PtlN' unique magic */
 159 #define LNET_PROTO_MX_MAGIC                 0x4d583130 /* 'MX10'! */
 160 #define LNET_PROTO_ACCEPTOR_MAGIC           0xacce7100
 161 #define LNET_PROTO_PING_MAGIC               0x70696E67 /* 'ping' */
 162
 163 /* Placeholder for a future "unified" protocol across all LNDs */
 164 /* Current LNDs that receive a request with this magic will respond with a
 165  * "stub" reply using their current protocol */
 166 #define LNET_PROTO_MAGIC                    0x45726963 /* ! */
 167
 168
 169 #define LNET_PROTO_TCP_VERSION_MAJOR        1
 170 #define LNET_PROTO_TCP_VERSION_MINOR        0
 171
 172 /* Acceptor connection request */
 173 typedef struct {
 174         __u32       acr_magic;                  /* PTL_ACCEPTOR_PROTO_MAGIC */
 175         __u32       acr_version;                /* protocol version */
 176         __u64       acr_nid;                    /* target NID */
 177 } WIRE_ATTR lnet_acceptor_connreq_t;
 178 #include <libcfs/libcfs_unpack.h>
 179
 180 #define LNET_PROTO_ACCEPTOR_VERSION       1
 181
 182 /* forward refs */
 183 struct lnet_libmd;
 184
 185 typedef struct lnet_msg {
 186         cfs_list_t            msg_activelist;
 187         cfs_list_t            msg_list;           /* Q for credits/MD */
 188
 189         lnet_process_id_t     msg_target;
 190         /* where is it from, it's only for building event */
 191         lnet_nid_t              msg_from;
 192         __u32                   msg_type;
 193
 194         unsigned int            msg_rx_committed:1;
 195         unsigned int            msg_tx_committed:1;
 196
 197         unsigned int          msg_vmflush:1;      /* VM trying to free memory */
 198         unsigned int          msg_target_is_router:1; /* sending to a router */
 199         unsigned int          msg_routing:1;      /* being forwarded */
 200         unsigned int          msg_ack:1;          /* ack on finalize (PUT) */
 201         unsigned int          msg_sending:1;      /* outgoing message */
 202         unsigned int          msg_receiving:1;    /* being received */
 203         unsigned int          msg_delayed:1;      /* had to Q for buffer or tx credit */
 204         unsigned int          msg_txcredit:1;     /* taken an NI send credit */
 205         unsigned int          msg_peertxcredit:1; /* taken a peer send credit */
 206         unsigned int          msg_rtrcredit:1;    /* taken a globel router credit */
 207         unsigned int          msg_peerrtrcredit:1; /* taken a peer router credit */
 208         unsigned int          msg_onactivelist:1; /* on the activelist */
 209
 210         struct lnet_peer     *msg_txpeer;         /* peer I'm sending to */
 211         struct lnet_peer     *msg_rxpeer;         /* peer I received from */
 212
 213         void                 *msg_private;
 214         struct lnet_libmd    *msg_md;
 215
 216         unsigned int          msg_len;
 217         unsigned int          msg_wanted;
 218         unsigned int          msg_offset;
 219         unsigned int          msg_niov;
 220         struct iovec         *msg_iov;
 221         lnet_kiov_t          *msg_kiov;
 222
 223         lnet_event_t          msg_ev;
 224         lnet_hdr_t            msg_hdr;
 225 } lnet_msg_t;
 226
 227
 228 typedef struct lnet_libhandle {
 229         cfs_list_t            lh_hash_chain;
 230         __u64                 lh_cookie;
 231 } lnet_libhandle_t;
 232
 233 #define lh_entry(ptr, type, member) \
 234         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
 235
 236 typedef struct lnet_eq {
 237         cfs_list_t            eq_list;
 238         lnet_libhandle_t      eq_lh;
 239         lnet_seq_t            eq_enq_seq;
 240         lnet_seq_t            eq_deq_seq;
 241         unsigned int          eq_size;
 242         lnet_event_t         *eq_events;
 243         int                   eq_refcount;
 244         lnet_eq_handler_t     eq_callback;
 245 } lnet_eq_t;
 246
 247 typedef struct lnet_me {
 248         cfs_list_t             me_list;
 249         lnet_libhandle_t       me_lh;
 250         lnet_process_id_t      me_match_id;
 251         unsigned int           me_portal;
 252         __u64                  me_match_bits;
 253         __u64                  me_ignore_bits;
 254         lnet_unlink_t          me_unlink;
 255         struct lnet_libmd     *me_md;
 256 } lnet_me_t;
 257
 258 typedef struct lnet_libmd {
 259         cfs_list_t            md_list;
 260         lnet_libhandle_t      md_lh;
 261         lnet_me_t            *md_me;
 262         char                 *md_start;
 263         unsigned int          md_offset;
 264         unsigned int          md_length;
 265         unsigned int          md_max_size;
 266         int                   md_threshold;
 267         int                   md_refcount;
 268         unsigned int          md_options;
 269         unsigned int          md_flags;
 270         void                 *md_user_ptr;
 271         lnet_eq_t            *md_eq;
 272         unsigned int          md_niov;                /* # frags */
 273         union {
 274                 struct iovec  iov[LNET_MAX_IOV];
 275                 lnet_kiov_t   kiov[LNET_MAX_IOV];
 276         } md_iov;
 277 } lnet_libmd_t;
 278
 279 #define LNET_MD_FLAG_ZOMBIE           (1 << 0)
 280 #define LNET_MD_FLAG_AUTO_UNLINK      (1 << 1)
 281
 282 #ifdef LNET_USE_LIB_FREELIST
 283 typedef struct
 284 {
 285         void                  *fl_objs;          /* single contiguous array of objects */
 286         int                    fl_nobjs;         /* the number of them */
 287         int                    fl_objsize;       /* the size (including overhead) of each of them */
 288         cfs_list_t             fl_list;          /* where they are enqueued */
 289 } lnet_freelist_t;
 290
 291 typedef struct
 292 {
 293         cfs_list_t             fo_list;             /* enqueue on fl_list */
 294         void                  *fo_contents;         /* aligned contents */
 295 } lnet_freeobj_t;
 296 #endif
 297
 298 typedef struct {
 299         /* info about peers we are trying to fail */
 300         cfs_list_t             tp_list;             /* ln_test_peers */
 301         lnet_nid_t             tp_nid;              /* matching nid */
 302         unsigned int           tp_threshold;        /* # failures to simulate */
 303 } lnet_test_peer_t;
 304
 305 #define LNET_COOKIE_TYPE_MD    1
 306 #define LNET_COOKIE_TYPE_ME    2
 307 #define LNET_COOKIE_TYPE_EQ    3
 308 #define LNET_COOKIE_TYPE_BITS  2
 309 #define LNET_COOKIE_TYPES      (1 << LNET_COOKIE_TYPE_BITS)
 310 /* LNET_COOKIE_TYPES must be a power of 2, so the cookie type can be
 311  * extracted by masking with (LNET_COOKIE_TYPES - 1) */
 312
 313 struct lnet_ni;                                  /* forward ref */
 314
 315 typedef struct lnet_lnd
 316 {
 317         /* fields managed by portals */
 318         cfs_list_t            lnd_list;             /* stash in the LND table */
 319         int                   lnd_refcount;         /* # active instances */
 320
 321         /* fields initialised by the LND */
 322         unsigned int          lnd_type;
 323
 324         int  (*lnd_startup) (struct lnet_ni *ni);
 325         void (*lnd_shutdown) (struct lnet_ni *ni);
 326         int  (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
 327
 328         /* In data movement APIs below, payload buffers are described as a set
 329          * of 'niov' fragments which are...
 330          * EITHER
 331          *    in virtual memory (struct iovec *iov != NULL)
 332          * OR
 333          *    in pages (kernel only: plt_kiov_t *kiov != NULL).
 334          * The LND may NOT overwrite these fragment descriptors.
 335          * An 'offset' and may specify a byte offset within the set of
 336          * fragments to start from
 337          */
 338
 339         /* Start sending a preformatted message.  'private' is NULL for PUT and
 340          * GET messages; otherwise this is a response to an incoming message
 341          * and 'private' is the 'private' passed to lnet_parse().  Return
 342          * non-zero for immediate failure, otherwise complete later with
 343          * lnet_finalize() */
 344         int (*lnd_send)(struct lnet_ni *ni, void *private, lnet_msg_t *msg);
 345
 346         /* Start receiving 'mlen' bytes of payload data, skipping the following
 347          * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
 348          * lnet_parse().  Return non-zero for immedaite failure, otherwise
 349          * complete later with lnet_finalize().  This also gives back a receive
 350          * credit if the LND does flow control. */
 351         int (*lnd_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
 352                         int delayed, unsigned int niov,
 353                         struct iovec *iov, lnet_kiov_t *kiov,
 354                         unsigned int offset, unsigned int mlen, unsigned int rlen);
 355
 356         /* lnet_parse() has had to delay processing of this message
 357          * (e.g. waiting for a forwarding buffer or send credits).  Give the
 358          * LND a chance to free urgently needed resources.  If called, return 0
 359          * for success and do NOT give back a receive credit; that has to wait
 360          * until lnd_recv() gets called.  On failure return < 0 and
 361          * release resources; lnd_recv() will not be called. */
 362         int (*lnd_eager_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
 363                               void **new_privatep);
 364
 365         /* notification of peer health */
 366         void (*lnd_notify)(struct lnet_ni *ni, lnet_nid_t peer, int alive);
 367
 368         /* query of peer aliveness */
 369         void (*lnd_query)(struct lnet_ni *ni, lnet_nid_t peer, cfs_time_t *when);
 370
 371 #if defined(__KERNEL__) || defined(HAVE_LIBPTHREAD)
 372         /* accept a new connection */
 373         int (*lnd_accept)(struct lnet_ni *ni, cfs_socket_t *sock);
 374 #endif
 375
 376 #ifndef __KERNEL__
 377         /* wait for something to happen */
 378         void (*lnd_wait)(struct lnet_ni *ni, int milliseconds);
 379
 380         /* ensure non-RDMA messages can be received outside liblustre */
 381         int (*lnd_setasync)(struct lnet_ni *ni, lnet_process_id_t id, int nasync);
 382 #endif
 383 } lnd_t;
 384
 385 #define LNET_NI_STATUS_UP      0x15aac0de
 386 #define LNET_NI_STATUS_DOWN    0xdeadface
 387 #define LNET_NI_STATUS_INVALID 0x00000000
 388 typedef struct {
 389         lnet_nid_t ns_nid;
 390         __u32      ns_status;
 391         __u32      ns_unused;
 392 } WIRE_ATTR lnet_ni_status_t;
 393
 394 #define LNET_MAX_INTERFACES   16
 395
 396 typedef struct lnet_ni {
 397         cfs_list_t        ni_list;              /* chain on ln_nis */
 398         cfs_list_t        ni_txq;               /* messages waiting for tx credits */
 399         int               ni_maxtxcredits;      /* # tx credits  */
 400         int               ni_txcredits;         /* # tx credits free */
 401         int               ni_mintxcredits;      /* lowest it's been */
 402         int               ni_peertxcredits;     /* # per-peer send credits */
 403         int               ni_peerrtrcredits;    /* # per-peer router buffer credits */
 404         int               ni_peertimeout;       /* seconds to consider peer dead */
 405         lnet_nid_t        ni_nid;               /* interface's NID */
 406         void             *ni_data;              /* instance-specific data */
 407         lnd_t            *ni_lnd;               /* procedural interface */
 408         int               ni_refcount;          /* reference count */
 409         /* when I was last alive */
 410         long                    ni_last_alive;
 411         lnet_ni_status_t        *ni_status;     /* my health status */
 412         /* equivalent interfaces to use */
 413         char                    *ni_interfaces[LNET_MAX_INTERFACES];
 414 } lnet_ni_t;
 415
 416 #define LNET_PROTO_PING_MATCHBITS     0x8000000000000000LL
 417 enum {
 418         LNET_PROTO_PING_UNKNOWN         = 0,    /* unknown */
 419         LNET_PROTO_PING_VERSION_1       = 1,    /* old version */
 420         LNET_PROTO_PING_VERSION         = 2,    /* current version */
 421 };
 422
 423 typedef struct {
 424         __u32            pi_magic;
 425         __u32            pi_version;
 426         lnet_pid_t       pi_pid;
 427         __u32            pi_nnis;
 428         lnet_ni_status_t pi_ni[0];
 429 } WIRE_ATTR lnet_ping_info_t;
 430
 431 /* router checker data, per router */
 432 #define LNET_MAX_RTR_NIS   16
 433 #define LNET_PINGINFO_SIZE offsetof(lnet_ping_info_t, pi_ni[LNET_MAX_RTR_NIS])
 434 typedef struct {
 435         /* chain on the_lnet.ln_zombie_rcd or ln_deathrow_rcd */
 436         cfs_list_t              rcd_list;
 437         lnet_handle_md_t        rcd_mdh;        /* ping buffer MD */
 438         struct lnet_peer        *rcd_gateway;   /* reference to gateway */
 439         lnet_ping_info_t        *rcd_pinginfo;  /* ping buffer */
 440 } lnet_rc_data_t;
 441
 442 typedef struct lnet_peer {
 443         cfs_list_t        lp_hashlist;          /* chain on peer hash */
 444         cfs_list_t        lp_txq;               /* messages blocking for tx credits */
 445         cfs_list_t        lp_rtrq;              /* messages blocking for router credits */
 446         cfs_list_t        lp_rtr_list;          /* chain on router list */
 447         int               lp_txcredits;         /* # tx credits available */
 448         int               lp_mintxcredits;      /* low water mark */
 449         int               lp_rtrcredits;        /* # router credits */
 450         int               lp_minrtrcredits;     /* low water mark */
 451         unsigned int      lp_alive:1;           /* alive/dead? */
 452         unsigned int      lp_notify:1;          /* notification outstanding? */
 453         unsigned int      lp_notifylnd:1;       /* outstanding notification for LND? */
 454         unsigned int      lp_notifying:1;       /* some thread is handling notification */
 455         unsigned int      lp_ping_notsent;      /* SEND event outstanding from ping */
 456         int               lp_alive_count;       /* # times router went dead<->alive */
 457         long              lp_txqnob;            /* bytes queued for sending */
 458         cfs_time_t        lp_timestamp;         /* time of last aliveness news */
 459         cfs_time_t        lp_ping_timestamp;    /* time of last ping attempt */
 460         cfs_time_t        lp_ping_deadline;     /* != 0 if ping reply expected */
 461         cfs_time_t        lp_last_alive;        /* when I was last alive */
 462         cfs_time_t        lp_last_query;        /* when lp_ni was queried last time */
 463         lnet_ni_t        *lp_ni;                /* interface peer is on */
 464         lnet_nid_t        lp_nid;               /* peer's NID */
 465         int               lp_refcount;          /* # refs */
 466         int               lp_rtr_refcount;      /* # refs from lnet_route_t::lr_gateway */
 467         /* returned RC ping version */
 468         unsigned int            lp_ping_version;
 469         cfs_list_t              lp_routes;      /* routers on this peer */
 470         lnet_rc_data_t          *lp_rcd;        /* router checker state */
 471 } lnet_peer_t;
 472
 473
 474 /* peer hash size */
 475 #define LNET_PEER_HASH_BITS     9
 476 #define LNET_PEER_HASH_SIZE     (1 << LNET_PEER_HASH_BITS)
 477
 478 /* peer hash table */
 479 struct lnet_peer_table {
 480         int                     pt_version;     /* /proc validity stamp */
 481         int                     pt_number;      /* # peers extant */
 482         cfs_list_t              pt_deathrow;    /* zombie peers */
 483         cfs_list_t              *pt_hash;       /* NID->peer hash */
 484 };
 485
 486 #define lnet_peer_aliveness_enabled(lp) ((lp)->lp_ni->ni_peertimeout > 0)
 487
 488 typedef struct {
 489         cfs_list_t              lr_list;        /* chain on net */
 490         cfs_list_t              lr_gwlist;      /* chain on gateway */
 491         lnet_peer_t             *lr_gateway;    /* router node */
 492         __u32                   lr_net;         /* remote network number */
 493         unsigned int            lr_downis;      /* number of down NIs */
 494         unsigned int            lr_hops;        /* how far I am */
 495 } lnet_route_t;
 496
 497 typedef struct {
 498         cfs_list_t              lrn_list;       /* chain on ln_remote_nets */
 499         cfs_list_t              lrn_routes;     /* routes to me */
 500         __u32                   lrn_net;        /* my net number */
 501 } lnet_remotenet_t;
 502
 503 typedef struct {
 504         cfs_list_t rbp_bufs;             /* my free buffer pool */
 505         cfs_list_t rbp_msgs;             /* messages blocking for a buffer */
 506         int        rbp_npages;           /* # pages in each buffer */
 507         int        rbp_nbuffers;         /* # buffers */
 508         int        rbp_credits;          /* # free buffers / blocked messages */
 509         int        rbp_mincredits;       /* low water mark */
 510 } lnet_rtrbufpool_t;
 511
 512 typedef struct {
 513         cfs_list_t             rb_list;             /* chain on rbp_bufs */
 514         lnet_rtrbufpool_t     *rb_pool;             /* owning pool */
 515         lnet_kiov_t            rb_kiov[0];          /* the buffer space */
 516 } lnet_rtrbuf_t;
 517
 518 #include <libcfs/libcfs_pack.h>
 519 typedef struct {
 520         __u32        msgs_alloc;
 521         __u32        msgs_max;
 522         __u32        errors;
 523         __u32        send_count;
 524         __u32        recv_count;
 525         __u32        route_count;
 526         __u32        drop_count;
 527         __u64        send_length;
 528         __u64        recv_length;
 529         __u64        route_length;
 530         __u64        drop_length;
 531 } WIRE_ATTR lnet_counters_t;
 532 #include <libcfs/libcfs_unpack.h>
 533
 534 #define LNET_PEER_HASHSIZE   503                /* prime! */
 535
 536 #define LNET_NRBPOOLS         3                 /* # different router buffer pools */
 537
 538 enum {
 539         /* Didn't match anything */
 540         LNET_MATCHMD_NONE       = (1 << 0),
 541         /* Matched OK */
 542         LNET_MATCHMD_OK         = (1 << 1),
 543         /* Must be discarded */
 544         LNET_MATCHMD_DROP       = (1 << 2),
 545 };
 546
 547 /* Options for lnet_portal_t::ptl_options */
 548 #define LNET_PTL_LAZY               (1 << 0)
 549 #define LNET_PTL_MATCH_UNIQUE       (1 << 1)    /* unique match, for RDMA */
 550 #define LNET_PTL_MATCH_WILDCARD     (1 << 2)    /* wildcard match, request portal */
 551
 552 /* ME hash of RDMA portal */
 553 #define LNET_PORTAL_HASH_BITS        8
 554 #define LNET_PORTAL_HASH_SIZE       (1 << LNET_PORTAL_HASH_BITS)
 555
 556 typedef struct lnet_portal {
 557         unsigned int            ptl_index;      /* portal ID, reserved */
 558         cfs_list_t       *ptl_mhash;            /* match hash */
 559         cfs_list_t        ptl_mlist;            /* match list */
 560         cfs_list_t        ptl_msgq;             /* messages blocking for MD */
 561         __u64             ptl_ml_version;       /* validity stamp, only changed for new attached MD */
 562         __u64             ptl_msgq_version;     /* validity stamp */
 563         unsigned int      ptl_options;
 564 } lnet_portal_t;
 565
 566 #define LNET_LH_HASH_BITS       12
 567 #define LNET_LH_HASH_SIZE       (1ULL << LNET_LH_HASH_BITS)
 568 #define LNET_LH_HASH_MASK       (LNET_LH_HASH_SIZE - 1)
 569
 570 /* resource container (ME, MD, EQ) */
 571 struct lnet_res_container {
 572         unsigned int            rec_type;       /* container type */
 573         __u64                   rec_lh_cookie;  /* cookie generator */
 574         cfs_list_t              rec_active;     /* active resource list */
 575         cfs_list_t              *rec_lh_hash;   /* handle hash */
 576 #ifdef LNET_USE_LIB_FREELIST
 577         lnet_freelist_t         rec_freelist;   /* freelist for resources */
 578 #endif
 579 };
 580
 581 /* message container */
 582 struct lnet_msg_container {
 583         int                     msc_init;       /* initialized or not */
 584         /* max # threads finalizing */
 585         int                     msc_nfinalizers;
 586         /* msgs waiting to complete finalizing */
 587         cfs_list_t              msc_finalizing;
 588         cfs_list_t              msc_active;     /* active message list */
 589         /* threads doing finalization */
 590         void                    **msc_finalizers;
 591 #ifdef LNET_USE_LIB_FREELIST
 592         lnet_freelist_t         msc_freelist;   /* freelist for messages */
 593 #endif
 594 };
 595
 596 /* Router Checker states */
 597 #define LNET_RC_STATE_SHUTDOWN          0       /* not started */
 598 #define LNET_RC_STATE_RUNNING           1       /* started up OK */
 599 #define LNET_RC_STATE_STOPPING          2       /* telling thread to stop */
 600
 601 typedef struct
 602 {
 603         /* Stuff initialised at LNetInit() */
 604         int                    ln_init;             /* LNetInit() called? */
 605         int                    ln_refcount;         /* LNetNIInit/LNetNIFini counter */
 606         int                    ln_niinit_self;      /* Have I called LNetNIInit myself? */
 607         /* shutdown in progress */
 608         int                             ln_shutdown;
 609
 610         cfs_list_t             ln_lnds;             /* registered LNDs */
 611
 612 #ifdef __KERNEL__
 613         cfs_spinlock_t         ln_lock;
 614         cfs_mutex_t            ln_api_mutex;
 615         cfs_mutex_t            ln_lnd_mutex;
 616         cfs_waitq_t                     ln_eq_waitq;
 617 #else
 618 # ifndef HAVE_LIBPTHREAD
 619         int                    ln_lock;
 620         int                    ln_api_mutex;
 621         int                    ln_lnd_mutex;
 622 # else
 623         pthread_mutex_t        ln_lock;
 624         pthread_mutex_t        ln_api_mutex;
 625         pthread_mutex_t        ln_lnd_mutex;
 626         pthread_cond_t                  ln_eq_cond;
 627 # endif
 628 #endif
 629         /* ME container  */
 630         struct lnet_res_container       ln_me_container;
 631         /* MD container  */
 632         struct lnet_res_container       ln_md_container;
 633         /* Event Queue container */
 634         struct lnet_res_container       ln_eq_container;
 635
 636         /* # portals */
 637         int                             ln_nportals;
 638         /* the vector of portals */
 639         lnet_portal_t                   **ln_portals;
 640
 641         lnet_pid_t             ln_pid;              /* requested pid */
 642
 643         cfs_list_t             ln_nis;              /* LND instances */
 644         lnet_ni_t             *ln_loni;             /* the loopback NI */
 645         /* NI to wait for events in */
 646         lnet_ni_t                       *ln_eq_waitni;
 647
 648         cfs_list_t             ln_zombie_nis;       /* dying LND instances */
 649         int                    ln_nzombie_nis;      /* # of NIs to wait for */
 650
 651         cfs_list_t             ln_remote_nets;      /* remote networks with routes to them */
 652         __u64                  ln_remote_nets_version; /* validity stamp */
 653
 654         cfs_list_t             ln_routers;       /* list of all known routers */
 655         __u64                  ln_routers_version;  /* validity stamp */
 656
 657         int                    ln_routing;          /* am I a router? */
 658         lnet_rtrbufpool_t      ln_rtrpools[LNET_NRBPOOLS]; /* router buffer pools */
 659
 660         __u64                  ln_interface_cookie; /* uniquely identifies this ni in this epoch */
 661
 662         char                  *ln_network_tokens;   /* space for network names */
 663         int                    ln_network_tokens_nob;
 664
 665         int                    ln_testprotocompat;  /* test protocol compatibility flags */
 666
 667         cfs_list_t             ln_test_peers;       /* failure simulation */
 668
 669         /* message container */
 670         struct lnet_peer_table          *ln_peer_table;
 671         struct lnet_msg_container       ln_msg_container;
 672
 673         lnet_handle_md_t       ln_ping_target_md;
 674         lnet_handle_eq_t       ln_ping_target_eq;
 675         lnet_ping_info_t      *ln_ping_info;
 676
 677 #ifdef __KERNEL__
 678         cfs_semaphore_t        ln_rc_signal;        /* serialise startup/shutdown */
 679 #endif
 680         /* router checker startup/shutdown state */
 681         int                             ln_rc_state;
 682         /* router checker's event queue */
 683         lnet_handle_eq_t                ln_rc_eqh;
 684         /* rcd still pending on net */
 685         cfs_list_t                      ln_rcd_deathrow;
 686         /* rcd ready for free */
 687         cfs_list_t                      ln_rcd_zombie;
 688
 689         lnet_counters_t        ln_counters;
 690
 691 #ifndef __KERNEL__
 692         /* Temporary workaround to allow uOSS and test programs force
 693          * server mode in userspace. The only place where we use it is
 694          * lnet_prepare(). The only way to turn this flag on is to
 695          * call lnet_server_mode() */
 696
 697         int                    ln_server_mode_flag;
 698 #endif
 699 } lnet_t;
 700
 701 #endif