Whamcloud - gitweb
8f1457235a19004230997f79008619d8bd85c0f0
[fs/lustre-release.git] / 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  * Copyright (c) 2012, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lnet/include/lnet/lib-types.h
37  *
38  * Types used by the library side routines that do not need to be
39  * exposed to the user application
40  */
41
42 #ifndef __LNET_LIB_TYPES_H__
43 #define __LNET_LIB_TYPES_H__
44
45 #include <lnet/linux/lib-types.h>
46
47 #include <libcfs/libcfs.h>
48 #include <libcfs/list.h>
49 #include <lnet/types.h>
50 #include <lnet/lnetctl.h>
51
52 #define WIRE_ATTR       __attribute__((packed))
53
54 /* Packed version of lnet_process_id_t to transfer via network */
55 typedef struct {
56         lnet_nid_t nid;
57         lnet_pid_t pid;   /* node id / process id */
58 } WIRE_ATTR lnet_process_id_packed_t;
59
60 /* The wire handle's interface cookie only matches one network interface in
61  * one epoch (i.e. new cookie when the interface restarts or the node
62  * reboots).  The object cookie only matches one object on that interface
63  * during that object's lifetime (i.e. no cookie re-use). */
64 typedef struct {
65         __u64 wh_interface_cookie;
66         __u64 wh_object_cookie;
67 } WIRE_ATTR lnet_handle_wire_t;
68
69 typedef enum {
70         LNET_MSG_ACK = 0,
71         LNET_MSG_PUT,
72         LNET_MSG_GET,
73         LNET_MSG_REPLY,
74         LNET_MSG_HELLO,
75 } lnet_msg_type_t;
76
77 /* The variant fields of the portals message header are aligned on an 8
78  * byte boundary in the message header.  Note that all types used in these
79  * wire structs MUST be fixed size and the smaller types are placed at the
80  * end. */
81 typedef struct lnet_ack {
82         lnet_handle_wire_t  dst_wmd;
83         __u64               match_bits;
84         __u32               mlength;
85 } WIRE_ATTR lnet_ack_t;
86
87 typedef struct lnet_put {
88         lnet_handle_wire_t  ack_wmd;
89         __u64               match_bits;
90         __u64               hdr_data;
91         __u32               ptl_index;
92         __u32               offset;
93 } WIRE_ATTR lnet_put_t;
94
95 typedef struct lnet_get {
96         lnet_handle_wire_t  return_wmd;
97         __u64               match_bits;
98         __u32               ptl_index;
99         __u32               src_offset;
100         __u32               sink_length;
101 } WIRE_ATTR lnet_get_t;
102
103 typedef struct lnet_reply {
104         lnet_handle_wire_t  dst_wmd;
105 } WIRE_ATTR lnet_reply_t;
106
107 typedef struct lnet_hello {
108         __u64              incarnation;
109         __u32              type;
110 } WIRE_ATTR lnet_hello_t;
111
112 typedef struct {
113         lnet_nid_t          dest_nid;
114         lnet_nid_t          src_nid;
115         lnet_pid_t          dest_pid;
116         lnet_pid_t          src_pid;
117         __u32               type;               /* lnet_msg_type_t */
118         __u32               payload_length;     /* payload data to follow */
119         /*<------__u64 aligned------->*/
120         union {
121                 lnet_ack_t   ack;
122                 lnet_put_t   put;
123                 lnet_get_t   get;
124                 lnet_reply_t reply;
125                 lnet_hello_t hello;
126         } msg;
127 } WIRE_ATTR lnet_hdr_t;
128
129 /* A HELLO message contains a magic number and protocol version
130  * code in the header's dest_nid, the peer's NID in the src_nid, and
131  * LNET_MSG_HELLO in the type field.  All other common fields are zero
132  * (including payload_size; i.e. no payload).
133  * This is for use by byte-stream LNDs (e.g. TCP/IP) to check the peer is
134  * running the same protocol and to find out its NID. These LNDs should
135  * exchange HELLO messages when a connection is first established.  Individual
136  * LNDs can put whatever else they fancy in lnet_hdr_t::msg.
137  */
138 typedef struct {
139         __u32   magic;                          /* LNET_PROTO_TCP_MAGIC */
140         __u16   version_major;                  /* increment on incompatible change */
141         __u16   version_minor;                  /* increment on compatible change */
142 } WIRE_ATTR lnet_magicversion_t;
143
144 /* PROTO MAGIC for LNDs */
145 #define LNET_PROTO_IB_MAGIC                 0x0be91b91
146 #define LNET_PROTO_RA_MAGIC                 0x0be91b92
147 #define LNET_PROTO_QSW_MAGIC                0x0be91b93
148 #define LNET_PROTO_GNI_MAGIC                0xb00fbabe /* ask Kim */
149 #define LNET_PROTO_TCP_MAGIC                0xeebc0ded
150 #define LNET_PROTO_PTL_MAGIC                0x50746C4E /* 'PtlN' unique magic */
151 #define LNET_PROTO_MX_MAGIC                 0x4d583130 /* 'MX10'! */
152 #define LNET_PROTO_ACCEPTOR_MAGIC           0xacce7100
153 #define LNET_PROTO_PING_MAGIC               0x70696E67 /* 'ping' */
154
155 /* Placeholder for a future "unified" protocol across all LNDs */
156 /* Current LNDs that receive a request with this magic will respond with a
157  * "stub" reply using their current protocol */
158 #define LNET_PROTO_MAGIC                    0x45726963 /* ! */
159
160
161 #define LNET_PROTO_TCP_VERSION_MAJOR        1
162 #define LNET_PROTO_TCP_VERSION_MINOR        0
163
164 /* Acceptor connection request */
165 typedef struct {
166         __u32       acr_magic;                  /* PTL_ACCEPTOR_PROTO_MAGIC */
167         __u32       acr_version;                /* protocol version */
168         __u64       acr_nid;                    /* target NID */
169 } WIRE_ATTR lnet_acceptor_connreq_t;
170
171 #define LNET_PROTO_ACCEPTOR_VERSION       1
172
173 /* forward refs */
174 struct lnet_libmd;
175
176 typedef struct lnet_msg {
177         struct list_head        msg_activelist;
178         struct list_head        msg_list;       /* Q for credits/MD */
179
180         lnet_process_id_t       msg_target;
181         /* where is it from, it's only for building event */
182         lnet_nid_t              msg_from;
183         __u32                   msg_type;
184
185         /* commited for sending */
186         unsigned int            msg_tx_committed:1;
187         /* CPT # this message committed for sending */
188         unsigned int            msg_tx_cpt:15;
189         /* commited for receiving */
190         unsigned int            msg_rx_committed:1;
191         /* CPT # this message committed for receiving */
192         unsigned int            msg_rx_cpt:15;
193         /* queued for tx credit */
194         unsigned int            msg_tx_delayed:1;
195         /* queued for RX buffer */
196         unsigned int            msg_rx_delayed:1;
197         /* ready for pending on RX delay list */
198         unsigned int            msg_rx_ready_delay:1;
199
200         unsigned int          msg_vmflush:1;      /* VM trying to free memory */
201         unsigned int          msg_target_is_router:1; /* sending to a router */
202         unsigned int          msg_routing:1;      /* being forwarded */
203         unsigned int          msg_ack:1;          /* ack on finalize (PUT) */
204         unsigned int          msg_sending:1;      /* outgoing message */
205         unsigned int          msg_receiving:1;    /* being received */
206         unsigned int          msg_txcredit:1;     /* taken an NI send credit */
207         unsigned int          msg_peertxcredit:1; /* taken a peer send credit */
208         unsigned int          msg_rtrcredit:1;    /* taken a globel router credit */
209         unsigned int          msg_peerrtrcredit:1; /* taken a peer router credit */
210         unsigned int          msg_onactivelist:1; /* on the activelist */
211
212         struct lnet_peer     *msg_txpeer;         /* peer I'm sending to */
213         struct lnet_peer     *msg_rxpeer;         /* peer I received from */
214
215         void                 *msg_private;
216         struct lnet_libmd    *msg_md;
217
218         unsigned int          msg_len;
219         unsigned int          msg_wanted;
220         unsigned int          msg_offset;
221         unsigned int          msg_niov;
222         struct iovec         *msg_iov;
223         lnet_kiov_t          *msg_kiov;
224
225         lnet_event_t          msg_ev;
226         lnet_hdr_t            msg_hdr;
227 } lnet_msg_t;
228
229
230 typedef struct lnet_libhandle {
231         struct list_head        lh_hash_chain;
232         __u64                   lh_cookie;
233 } lnet_libhandle_t;
234
235 #define lh_entry(ptr, type, member) \
236         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
237
238 typedef struct lnet_eq {
239         struct list_head        eq_list;
240         lnet_libhandle_t        eq_lh;
241         lnet_seq_t              eq_enq_seq;
242         lnet_seq_t              eq_deq_seq;
243         unsigned int            eq_size;
244         lnet_eq_handler_t       eq_callback;
245         lnet_event_t            *eq_events;
246         int                     **eq_refs;      /* percpt refcount for EQ */
247 } lnet_eq_t;
248
249 typedef struct lnet_me {
250         struct list_head        me_list;
251         lnet_libhandle_t        me_lh;
252         lnet_process_id_t       me_match_id;
253         unsigned int            me_portal;
254         unsigned int            me_pos;         /* hash offset in mt_hash */
255         __u64                   me_match_bits;
256         __u64                   me_ignore_bits;
257         lnet_unlink_t           me_unlink;
258         struct lnet_libmd      *me_md;
259 } lnet_me_t;
260
261 typedef struct lnet_libmd {
262         struct list_head        md_list;
263         lnet_libhandle_t        md_lh;
264         lnet_me_t              *md_me;
265         char                   *md_start;
266         unsigned int            md_offset;
267         unsigned int            md_length;
268         unsigned int            md_max_size;
269         int                     md_threshold;
270         int                     md_refcount;
271         unsigned int            md_options;
272         unsigned int            md_flags;
273         void                   *md_user_ptr;
274         lnet_eq_t              *md_eq;
275         unsigned int            md_niov;        /* # frags */
276         union {
277                 struct iovec    iov[LNET_MAX_IOV];
278                 lnet_kiov_t     kiov[LNET_MAX_IOV];
279         } md_iov;
280 } lnet_libmd_t;
281
282 #define LNET_MD_FLAG_ZOMBIE      (1 << 0)
283 #define LNET_MD_FLAG_AUTO_UNLINK (1 << 1)
284 #define LNET_MD_FLAG_ABORTED     (1 << 2)
285
286 #ifdef LNET_USE_LIB_FREELIST
287 typedef struct
288 {
289         /* single contiguous array of objects */
290         void                   *fl_objs;
291         /* the number of them */
292         int                     fl_nobjs;
293         /* the size (including overhead) of each of them */
294         int                     fl_objsize;
295         /* where they are enqueued */
296         struct list_head        fl_list;
297 } lnet_freelist_t;
298
299 typedef struct
300 {
301         struct list_head        fo_list;        /* enqueue on fl_list */
302         void                   *fo_contents;    /* aligned contents */
303 } lnet_freeobj_t;
304 #endif
305
306 typedef struct {
307         /* info about peers we are trying to fail */
308         struct list_head        tp_list;        /* ln_test_peers */
309         lnet_nid_t              tp_nid;         /* matching nid */
310         unsigned int            tp_threshold;   /* # failures to simulate */
311 } lnet_test_peer_t;
312
313 #define LNET_COOKIE_TYPE_MD    1
314 #define LNET_COOKIE_TYPE_ME    2
315 #define LNET_COOKIE_TYPE_EQ    3
316 #define LNET_COOKIE_TYPE_BITS  2
317 #define LNET_COOKIE_MASK        ((1ULL << LNET_COOKIE_TYPE_BITS) - 1ULL)
318
319 struct lnet_ni;                                  /* forward ref */
320
321 typedef struct lnet_lnd
322 {
323         /* fields managed by portals */
324         struct list_head        lnd_list;       /* stash in the LND table */
325         int                     lnd_refcount;   /* # active instances */
326
327         /* fields initialised by the LND */
328         unsigned int          lnd_type;
329
330         int  (*lnd_startup) (struct lnet_ni *ni);
331         void (*lnd_shutdown) (struct lnet_ni *ni);
332         int  (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
333
334         /* In data movement APIs below, payload buffers are described as a set
335          * of 'niov' fragments which are...
336          * EITHER
337          *    in virtual memory (struct iovec *iov != NULL)
338          * OR
339          *    in pages (kernel only: plt_kiov_t *kiov != NULL).
340          * The LND may NOT overwrite these fragment descriptors.
341          * An 'offset' and may specify a byte offset within the set of
342          * fragments to start from
343          */
344
345         /* Start sending a preformatted message.  'private' is NULL for PUT and
346          * GET messages; otherwise this is a response to an incoming message
347          * and 'private' is the 'private' passed to lnet_parse().  Return
348          * non-zero for immediate failure, otherwise complete later with
349          * lnet_finalize() */
350         int (*lnd_send)(struct lnet_ni *ni, void *private, lnet_msg_t *msg);
351
352         /* Start receiving 'mlen' bytes of payload data, skipping the following
353          * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
354          * lnet_parse().  Return non-zero for immedaite failure, otherwise
355          * complete later with lnet_finalize().  This also gives back a receive
356          * credit if the LND does flow control. */
357         int (*lnd_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
358                         int delayed, unsigned int niov,
359                         struct iovec *iov, lnet_kiov_t *kiov,
360                         unsigned int offset, unsigned int mlen, unsigned int rlen);
361
362         /* lnet_parse() has had to delay processing of this message
363          * (e.g. waiting for a forwarding buffer or send credits).  Give the
364          * LND a chance to free urgently needed resources.  If called, return 0
365          * for success and do NOT give back a receive credit; that has to wait
366          * until lnd_recv() gets called.  On failure return < 0 and
367          * release resources; lnd_recv() will not be called. */
368         int (*lnd_eager_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
369                               void **new_privatep);
370
371         /* notification of peer health */
372         void (*lnd_notify)(struct lnet_ni *ni, lnet_nid_t peer, int alive);
373
374         /* query of peer aliveness */
375         void (*lnd_query)(struct lnet_ni *ni, lnet_nid_t peer, cfs_time_t *when);
376
377 #if defined(__KERNEL__) || defined(HAVE_LIBPTHREAD)
378         /* accept a new connection */
379         int (*lnd_accept)(struct lnet_ni *ni, cfs_socket_t *sock);
380 #endif
381
382 #ifndef __KERNEL__
383         /* wait for something to happen */
384         void (*lnd_wait)(struct lnet_ni *ni, int milliseconds);
385
386         /* ensure non-RDMA messages can be received outside liblustre */
387         int (*lnd_setasync)(struct lnet_ni *ni, lnet_process_id_t id, int nasync);
388 #endif
389 } lnd_t;
390
391 #define LNET_NI_STATUS_UP      0x15aac0de
392 #define LNET_NI_STATUS_DOWN    0xdeadface
393 #define LNET_NI_STATUS_INVALID 0x00000000
394 typedef struct {
395         lnet_nid_t ns_nid;
396         __u32      ns_status;
397         __u32      ns_unused;
398 } WIRE_ATTR lnet_ni_status_t;
399
400 struct lnet_tx_queue {
401         int                     tq_credits;     /* # tx credits free */
402         int                     tq_credits_min; /* lowest it's been */
403         int                     tq_credits_max; /* total # tx credits */
404         struct list_head        tq_delayed;     /* delayed TXs */
405 };
406
407 #define LNET_MAX_INTERFACES     16
408
409 typedef struct lnet_ni {
410 #ifdef __KERNEL__
411         spinlock_t              ni_lock;
412 #else
413 # ifndef HAVE_LIBPTHREAD
414         int                     ni_lock;
415 # else
416         pthread_mutex_t         ni_lock;
417 # endif
418 #endif
419         struct list_head        ni_list;        /* chain on ln_nis */
420         struct list_head        ni_cptlist;     /* chain on ln_nis_cpt */
421         int                     ni_maxtxcredits; /* # tx credits  */
422         /* # per-peer send credits */
423         int                     ni_peertxcredits;
424         /* # per-peer router buffer credits */
425         int                     ni_peerrtrcredits;
426         /* seconds to consider peer dead */
427         int                     ni_peertimeout;
428         int                     ni_ncpts;       /* number of CPTs */
429         __u32                   *ni_cpts;       /* bond NI on some CPTs */
430         lnet_nid_t              ni_nid;         /* interface's NID */
431         void                    *ni_data;       /* instance-specific data */
432         lnd_t                   *ni_lnd;        /* procedural interface */
433         struct lnet_tx_queue    **ni_tx_queues; /* percpt TX queues */
434         int                     **ni_refs;      /* percpt reference count */
435         long                    ni_last_alive;  /* when I was last alive */
436         lnet_ni_status_t        *ni_status;     /* my health status */
437         /* equivalent interfaces to use */
438         char                    *ni_interfaces[LNET_MAX_INTERFACES];
439 } lnet_ni_t;
440
441 #define LNET_PROTO_PING_MATCHBITS       0x8000000000000000LL
442
443 /* NB: value of these features equal to LNET_PROTO_PING_VERSION_x
444  * of old LNet, so there shouldn't be any compatibility issue */
445 #define LNET_PING_FEAT_INVAL            (0)             /* no feature */
446 #define LNET_PING_FEAT_BASE             (1 << 0)        /* just a ping */
447 #define LNET_PING_FEAT_NI_STATUS        (1 << 1)        /* return NI status */
448 #define LNET_PING_FEAT_RTE_DISABLED     (1 << 2)        /* Routing enabled */
449
450 #define LNET_PING_FEAT_MASK             (LNET_PING_FEAT_BASE | \
451                                          LNET_PING_FEAT_NI_STATUS)
452
453 typedef struct {
454         __u32                   pi_magic;
455         __u32                   pi_features;
456         lnet_pid_t              pi_pid;
457         __u32                   pi_nnis;
458         lnet_ni_status_t        pi_ni[0];
459 } WIRE_ATTR lnet_ping_info_t;
460
461 /* router checker data, per router */
462 #define LNET_MAX_RTR_NIS   16
463 #define LNET_PINGINFO_SIZE offsetof(lnet_ping_info_t, pi_ni[LNET_MAX_RTR_NIS])
464 typedef struct {
465         /* chain on the_lnet.ln_zombie_rcd or ln_deathrow_rcd */
466         struct list_head        rcd_list;
467         lnet_handle_md_t        rcd_mdh;        /* ping buffer MD */
468         struct lnet_peer        *rcd_gateway;   /* reference to gateway */
469         lnet_ping_info_t        *rcd_pinginfo;  /* ping buffer */
470 } lnet_rc_data_t;
471
472 typedef struct lnet_peer {
473         /* chain on peer hash */
474         struct list_head        lp_hashlist;
475         /* messages blocking for tx credits */
476         struct list_head        lp_txq;
477         /* messages blocking for router credits */
478         struct list_head        lp_rtrq;
479         /* chain on router list */
480         struct list_head        lp_rtr_list;
481         /* # tx credits available */
482         int                     lp_txcredits;
483         /* low water mark */
484         int                     lp_mintxcredits;
485         /* # router credits */
486         int                     lp_rtrcredits;
487         /* low water mark */
488         int                     lp_minrtrcredits;
489         /* alive/dead? */
490         unsigned int            lp_alive:1;
491         /* notification outstanding? */
492         unsigned int            lp_notify:1;
493         /* outstanding notification for LND? */
494         unsigned int            lp_notifylnd:1;
495         /* some thread is handling notification */
496         unsigned int            lp_notifying:1;
497         /* SEND event outstanding from ping */
498         unsigned int            lp_ping_notsent;
499         /* # times router went dead<->alive */
500         int                     lp_alive_count;
501         /* bytes queued for sending */
502         long                    lp_txqnob;
503         /* time of last aliveness news */
504         cfs_time_t              lp_timestamp;
505         /* time of last ping attempt */
506         cfs_time_t              lp_ping_timestamp;
507         /* != 0 if ping reply expected */
508         cfs_time_t              lp_ping_deadline;
509         /* when I was last alive */
510         cfs_time_t              lp_last_alive;
511         /* when lp_ni was queried last time */
512         cfs_time_t              lp_last_query;
513         /* interface peer is on */
514         lnet_ni_t               *lp_ni;
515         lnet_nid_t              lp_nid;         /* peer's NID */
516         int                     lp_refcount;    /* # refs */
517         int                     lp_cpt;         /* CPT this peer attached on */
518         /* # refs from lnet_route_t::lr_gateway */
519         int                     lp_rtr_refcount;
520         /* returned RC ping features */
521         unsigned int            lp_ping_feats;
522         struct list_head        lp_routes;      /* routers on this peer */
523         lnet_rc_data_t          *lp_rcd;        /* router checker state */
524 } lnet_peer_t;
525
526 /* peer hash size */
527 #define LNET_PEER_HASH_BITS     9
528 #define LNET_PEER_HASH_SIZE     (1 << LNET_PEER_HASH_BITS)
529
530 /* peer hash table */
531 struct lnet_peer_table {
532         int                     pt_version;     /* /proc validity stamp */
533         int                     pt_number;      /* # peers extant */
534         int                     pt_zombies;     /* # zombies to go to deathrow
535                                                  * (and not there yet) */
536         struct list_head        pt_deathrow;    /* zombie peers */
537         struct list_head        *pt_hash;       /* NID->peer hash */
538 };
539
540 /* peer aliveness is enabled only on routers for peers in a network where the
541  * lnet_ni_t::ni_peertimeout has been set to a positive value */
542 #define lnet_peer_aliveness_enabled(lp) (the_lnet.ln_routing != 0 && \
543                                          (lp)->lp_ni->ni_peertimeout > 0)
544
545 typedef struct {
546         struct list_head        lr_list;        /* chain on net */
547         struct list_head        lr_gwlist;      /* chain on gateway */
548         lnet_peer_t             *lr_gateway;    /* router node */
549         __u32                   lr_net;         /* remote network number */
550         int                     lr_seq;         /* sequence for round-robin */
551         unsigned int            lr_downis;      /* number of down NIs */
552         unsigned int            lr_hops;        /* how far I am */
553         unsigned int            lr_priority;    /* route priority */
554 } lnet_route_t;
555
556 #define LNET_REMOTE_NETS_HASH_DEFAULT   (1U << 7)
557 #define LNET_REMOTE_NETS_HASH_MAX       (1U << 16)
558 #define LNET_REMOTE_NETS_HASH_SIZE      (1 << the_lnet.ln_remote_nets_hbits)
559
560 typedef struct {
561         /* chain on ln_remote_nets_hash */
562         struct list_head        lrn_list;
563         /* routes to me */
564         struct list_head        lrn_routes;
565         /* my net number */
566         __u32                   lrn_net;
567 } lnet_remotenet_t;
568
569 typedef struct {
570         /* my free buffer pool */
571         struct list_head        rbp_bufs;
572         /* messages blocking for a buffer */
573         struct list_head        rbp_msgs;
574         /* # pages in each buffer */
575         int                     rbp_npages;
576         /* # buffers */
577         int                     rbp_nbuffers;
578         /* # free buffers / blocked messages */
579         int                     rbp_credits;
580         /* low water mark */
581         int                     rbp_mincredits;
582 } lnet_rtrbufpool_t;
583
584 typedef struct {
585         struct list_head         rb_list;       /* chain on rbp_bufs */
586         lnet_rtrbufpool_t       *rb_pool;       /* owning pool */
587         lnet_kiov_t              rb_kiov[0];    /* the buffer space */
588 } lnet_rtrbuf_t;
589
590 typedef struct lnet_counters {
591         __u32 msgs_alloc;
592         __u32 msgs_max;
593         __u32 errors;
594         __u32 send_count;
595         __u32 recv_count;
596         __u32 route_count;
597         __u32 drop_count;
598         __u64 send_length;
599         __u64 recv_length;
600         __u64 route_length;
601         __u64 drop_length;
602 } WIRE_ATTR lnet_counters_t;
603
604 #define LNET_PEER_HASHSIZE   503                /* prime! */
605
606 #define LNET_TINY_BUF_IDX       0
607 #define LNET_SMALL_BUF_IDX      1
608 #define LNET_LARGE_BUF_IDX      2
609
610 /* # different router buffer pools */
611 #define LNET_NRBPOOLS           (LNET_LARGE_BUF_IDX + 1)
612
613 enum {
614         /* Didn't match anything */
615         LNET_MATCHMD_NONE       = (1 << 0),
616         /* Matched OK */
617         LNET_MATCHMD_OK         = (1 << 1),
618         /* Must be discarded */
619         LNET_MATCHMD_DROP       = (1 << 2),
620         /* match and buffer is exhausted */
621         LNET_MATCHMD_EXHAUSTED  = (1 << 3),
622         /* match or drop */
623         LNET_MATCHMD_FINISH     = (LNET_MATCHMD_OK | LNET_MATCHMD_DROP),
624 };
625
626 /* Options for lnet_portal_t::ptl_options */
627 #define LNET_PTL_LAZY               (1 << 0)
628 #define LNET_PTL_MATCH_UNIQUE       (1 << 1)    /* unique match, for RDMA */
629 #define LNET_PTL_MATCH_WILDCARD     (1 << 2)    /* wildcard match, request portal */
630
631 /* parameter for matching operations (GET, PUT) */
632 struct lnet_match_info {
633         __u64                   mi_mbits;
634         lnet_process_id_t       mi_id;
635         unsigned int            mi_opc;
636         unsigned int            mi_portal;
637         unsigned int            mi_rlength;
638         unsigned int            mi_roffset;
639 };
640
641 /* ME hash of RDMA portal */
642 #define LNET_MT_HASH_BITS               8
643 #define LNET_MT_HASH_SIZE               (1 << LNET_MT_HASH_BITS)
644 #define LNET_MT_HASH_MASK               (LNET_MT_HASH_SIZE - 1)
645 /* we allocate (LNET_MT_HASH_SIZE + 1) entries for lnet_match_table::mt_hash,
646  * the last entry is reserved for MEs with ignore-bits */
647 #define LNET_MT_HASH_IGNORE             LNET_MT_HASH_SIZE
648 /* __u64 has 2^6 bits, so need 2^(LNET_MT_HASH_BITS - LNET_MT_BITS_U64) which
649  * is 4 __u64s as bit-map, and add an extra __u64 (only use one bit) for the
650  * ME-list with ignore-bits, which is mtable::mt_hash[LNET_MT_HASH_IGNORE] */
651 #define LNET_MT_BITS_U64                6       /* 2^6 bits */
652 #define LNET_MT_EXHAUSTED_BITS          (LNET_MT_HASH_BITS - LNET_MT_BITS_U64)
653 #define LNET_MT_EXHAUSTED_BMAP          ((1 << LNET_MT_EXHAUSTED_BITS) + 1)
654
655 /* portal match table */
656 struct lnet_match_table {
657         /* reserved for upcoming patches, CPU partition ID */
658         unsigned int            mt_cpt;
659         unsigned int            mt_portal;      /* portal index */
660         /* match table is set as "enabled" if there's non-exhausted MD
661          * attached on mt_mhash, it's only valide for wildcard portal */
662         unsigned int            mt_enabled;
663         /* bitmap to flag whether MEs on mt_hash are exhausted or not */
664         __u64                   mt_exhausted[LNET_MT_EXHAUSTED_BMAP];
665         struct list_head        *mt_mhash;      /* matching hash */
666 };
667
668 /* these are only useful for wildcard portal */
669 /* Turn off message rotor for wildcard portals */
670 #define LNET_PTL_ROTOR_OFF      0
671 /* round-robin dispatch all PUT messages for wildcard portals */
672 #define LNET_PTL_ROTOR_ON       1
673 /* round-robin dispatch routed PUT message for wildcard portals */
674 #define LNET_PTL_ROTOR_RR_RT    2
675 /* dispatch routed PUT message by hashing source NID for wildcard portals */
676 #define LNET_PTL_ROTOR_HASH_RT  3
677
678 typedef struct lnet_portal {
679 #ifdef __KERNEL__
680         spinlock_t              ptl_lock;
681 #else
682 # ifndef HAVE_LIBPTHREAD
683         int                     ptl_lock;
684 # else
685         pthread_mutex_t         ptl_lock;
686 # endif
687 #endif
688         unsigned int            ptl_index;      /* portal ID, reserved */
689         /* flags on this portal: lazy, unique... */
690         unsigned int            ptl_options;
691         /* list of messags which are stealing buffer */
692         struct list_head        ptl_msg_stealing;
693         /* messages blocking for MD */
694         struct list_head        ptl_msg_delayed;
695         /* Match table for each CPT */
696         struct lnet_match_table **ptl_mtables;
697         /* spread rotor of incoming "PUT" */
698         unsigned int            ptl_rotor;
699         /* # active entries for this portal */
700         int                     ptl_mt_nmaps;
701         /* array of active entries' cpu-partition-id */
702         int                     ptl_mt_maps[0];
703 } lnet_portal_t;
704
705 #define LNET_LH_HASH_BITS       12
706 #define LNET_LH_HASH_SIZE       (1ULL << LNET_LH_HASH_BITS)
707 #define LNET_LH_HASH_MASK       (LNET_LH_HASH_SIZE - 1)
708
709 /* resource container (ME, MD, EQ) */
710 struct lnet_res_container {
711         unsigned int            rec_type;       /* container type */
712         __u64                   rec_lh_cookie;  /* cookie generator */
713         struct list_head        rec_active;     /* active resource list */
714         struct list_head        *rec_lh_hash;   /* handle hash */
715 #ifdef LNET_USE_LIB_FREELIST
716         lnet_freelist_t         rec_freelist;   /* freelist for resources */
717 #endif
718 };
719
720 /* message container */
721 struct lnet_msg_container {
722         int                     msc_init;       /* initialized or not */
723         /* max # threads finalizing */
724         int                     msc_nfinalizers;
725         /* msgs waiting to complete finalizing */
726         struct list_head        msc_finalizing;
727         struct list_head        msc_active;     /* active message list */
728         /* threads doing finalization */
729         void                    **msc_finalizers;
730 #ifdef LNET_USE_LIB_FREELIST
731         lnet_freelist_t         msc_freelist;   /* freelist for messages */
732 #endif
733 };
734
735 /* Router Checker states */
736 #define LNET_RC_STATE_SHUTDOWN          0       /* not started */
737 #define LNET_RC_STATE_RUNNING           1       /* started up OK */
738 #define LNET_RC_STATE_STOPPING          2       /* telling thread to stop */
739
740 typedef struct
741 {
742         /* CPU partition table of LNet */
743         struct cfs_cpt_table            *ln_cpt_table;
744         /* number of CPTs in ln_cpt_table */
745         unsigned int                    ln_cpt_number;
746         unsigned int                    ln_cpt_bits;
747
748         /* protect LNet resources (ME/MD/EQ) */
749         struct cfs_percpt_lock          *ln_res_lock;
750         /* # portals */
751         int                             ln_nportals;
752         /* the vector of portals */
753         lnet_portal_t                   **ln_portals;
754         /* percpt ME containers */
755         struct lnet_res_container       **ln_me_containers;
756         /* percpt MD container */
757         struct lnet_res_container       **ln_md_containers;
758
759         /* Event Queue container */
760         struct lnet_res_container       ln_eq_container;
761 #ifdef __KERNEL__
762         wait_queue_head_t               ln_eq_waitq;
763         spinlock_t                      ln_eq_wait_lock;
764 #else
765 # ifndef HAVE_LIBPTHREAD
766         int                             ln_eq_wait_lock;
767 # else
768         pthread_cond_t                  ln_eq_cond;
769         pthread_mutex_t                 ln_eq_wait_lock;
770 # endif
771 #endif
772         unsigned int                    ln_remote_nets_hbits;
773
774         /* protect NI, peer table, credits, routers, rtrbuf... */
775         struct cfs_percpt_lock          *ln_net_lock;
776         /* percpt message containers for active/finalizing/freed message */
777         struct lnet_msg_container       **ln_msg_containers;
778         lnet_counters_t                 **ln_counters;
779         struct lnet_peer_table          **ln_peer_tables;
780         /* failure simulation */
781         struct list_head                ln_test_peers;
782         struct list_head                ln_drop_rules;
783
784         struct list_head                ln_nis;         /* LND instances */
785         /* NIs bond on specific CPT(s) */
786         struct list_head                ln_nis_cpt;
787         /* dying LND instances */
788         struct list_head                ln_nis_zombie;
789         lnet_ni_t                       *ln_loni;       /* the loopback NI */
790         /* NI to wait for events in */
791         lnet_ni_t                       *ln_eq_waitni;
792
793         /* remote networks with routes to them */
794         struct list_head                *ln_remote_nets_hash;
795         /* validity stamp */
796         __u64                           ln_remote_nets_version;
797         /* list of all known routers */
798         struct list_head                ln_routers;
799         /* validity stamp */
800         __u64                           ln_routers_version;
801         /* percpt router buffer pools */
802         lnet_rtrbufpool_t               **ln_rtrpools;
803
804         lnet_handle_md_t                ln_ping_target_md;
805         lnet_handle_eq_t                ln_ping_target_eq;
806         lnet_ping_info_t                *ln_ping_info;
807
808         /* router checker startup/shutdown state */
809         int                             ln_rc_state;
810         /* router checker's event queue */
811         lnet_handle_eq_t                ln_rc_eqh;
812         /* rcd still pending on net */
813         struct list_head                ln_rcd_deathrow;
814         /* rcd ready for free */
815         struct list_head                ln_rcd_zombie;
816 #ifdef __KERNEL__
817         /* serialise startup/shutdown */
818         struct semaphore                ln_rc_signal;
819
820         struct mutex                    ln_api_mutex;
821         struct mutex                    ln_lnd_mutex;
822 #else
823 # ifndef HAVE_LIBPTHREAD
824         int                             ln_api_mutex;
825         int                             ln_lnd_mutex;
826 # else
827         pthread_mutex_t                 ln_api_mutex;
828         pthread_mutex_t                 ln_lnd_mutex;
829 # endif
830 #endif
831         int                             ln_init;        /* LNetInit() called? */
832         /* Have I called LNetNIInit myself? */
833         int                             ln_niinit_self;
834         /* LNetNIInit/LNetNIFini counter */
835         int                             ln_refcount;
836         /* shutdown in progress */
837         int                             ln_shutdown;
838
839         int                             ln_routing;     /* am I a router? */
840         lnet_pid_t                      ln_pid;         /* requested pid */
841         /* uniquely identifies this ni in this epoch */
842         __u64                           ln_interface_cookie;
843         /* registered LNDs */
844         struct list_head                ln_lnds;
845
846         /* test protocol compatibility flags */
847         int                             ln_testprotocompat;
848
849         /* 0 - load the NIs from the mod params
850          * 1 - do not load the NIs from the mod params
851          * Reverse logic to ensure that other calls to LNetNIInit
852          * need no change
853          */
854         bool                            ln_nis_from_mod_params;
855
856 #ifndef __KERNEL__
857         /* Temporary workaround to allow uOSS and test programs force
858          * server mode in userspace. The only place where we use it is
859          * lnet_prepare(). The only way to turn this flag on is to
860          * call lnet_server_mode() */
861         int                             ln_server_mode_flag;
862 #endif
863 } lnet_t;
864
865 #endif