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