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