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