Whamcloud - gitweb
LU-9480 lnet: introduce LNET_PEER_MULTI_RAIL flag bit
[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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2016, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lnet/include/lnet/lib-types.h
33  *
34  * Types used by the library side routines that do not need to be
35  * exposed to the user application
36  */
37
38 #ifndef __LNET_LIB_TYPES_H__
39 #define __LNET_LIB_TYPES_H__
40
41 #ifndef __KERNEL__
42 # error This include is only for kernel use.
43 #endif
44
45 #include <linux/kthread.h>
46 #include <linux/uio.h>
47 #include <linux/types.h>
48
49 #include <uapi/linux/lnet/lnet-dlc.h>
50 #include <uapi/linux/lnet/lnetctl.h>
51
52 /* Max payload size */
53 #ifndef CONFIG_LNET_MAX_PAYLOAD
54 # error "CONFIG_LNET_MAX_PAYLOAD must be defined in config.h"
55 #endif
56
57 #define LNET_MAX_PAYLOAD       CONFIG_LNET_MAX_PAYLOAD
58 #if (LNET_MAX_PAYLOAD < LNET_MTU)
59 # error "LNET_MAX_PAYLOAD too small - error in configure --with-max-payload-mb"
60 #elif (LNET_MAX_PAYLOAD > (PAGE_SIZE * LNET_MAX_IOV))
61 # error "LNET_MAX_PAYLOAD too large - error in configure --with-max-payload-mb"
62 #endif
63
64 /* forward refs */
65 struct lnet_libmd;
66
67 typedef struct lnet_msg {
68         struct list_head        msg_activelist;
69         struct list_head        msg_list;       /* Q for credits/MD */
70
71         struct lnet_process_id  msg_target;
72         /* Primary NID of the source. */
73         lnet_nid_t              msg_initiator;
74         /* where is it from, it's only for building event */
75         lnet_nid_t              msg_from;
76         __u32                   msg_type;
77
78         /* committed for sending */
79         unsigned int            msg_tx_committed:1;
80         /* CPT # this message committed for sending */
81         unsigned int            msg_tx_cpt:15;
82         /* committed for receiving */
83         unsigned int            msg_rx_committed:1;
84         /* CPT # this message committed for receiving */
85         unsigned int            msg_rx_cpt:15;
86         /* queued for tx credit */
87         unsigned int            msg_tx_delayed:1;
88         /* queued for RX buffer */
89         unsigned int            msg_rx_delayed:1;
90         /* ready for pending on RX delay list */
91         unsigned int            msg_rx_ready_delay:1;
92
93         unsigned int          msg_vmflush:1;      /* VM trying to free memory */
94         unsigned int          msg_target_is_router:1; /* sending to a router */
95         unsigned int          msg_routing:1;      /* being forwarded */
96         unsigned int          msg_ack:1;          /* ack on finalize (PUT) */
97         unsigned int          msg_sending:1;      /* outgoing message */
98         unsigned int          msg_receiving:1;    /* being received */
99         unsigned int          msg_txcredit:1;     /* taken an NI send credit */
100         unsigned int          msg_peertxcredit:1; /* taken a peer send credit */
101         unsigned int          msg_rtrcredit:1;    /* taken a globel router credit */
102         unsigned int          msg_peerrtrcredit:1; /* taken a peer router credit */
103         unsigned int          msg_onactivelist:1; /* on the activelist */
104         unsigned int          msg_rdma_get:1;
105
106         struct lnet_peer_ni  *msg_txpeer;         /* peer I'm sending to */
107         struct lnet_peer_ni  *msg_rxpeer;         /* peer I received from */
108
109         void                 *msg_private;
110         struct lnet_libmd    *msg_md;
111         /* the NI the message was sent or received over */
112         struct lnet_ni       *msg_txni;
113         struct lnet_ni       *msg_rxni;
114
115         unsigned int          msg_len;
116         unsigned int          msg_wanted;
117         unsigned int          msg_offset;
118         unsigned int          msg_niov;
119         struct kvec          *msg_iov;
120         lnet_kiov_t          *msg_kiov;
121
122         struct lnet_event       msg_ev;
123         struct lnet_hdr         msg_hdr;
124 } lnet_msg_t;
125
126 typedef struct lnet_libhandle {
127         struct list_head        lh_hash_chain;
128         __u64                   lh_cookie;
129 } lnet_libhandle_t;
130
131 #define lh_entry(ptr, type, member) \
132         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
133
134 typedef struct lnet_eq {
135         struct list_head        eq_list;
136         struct lnet_libhandle   eq_lh;
137         unsigned long           eq_enq_seq;
138         unsigned long           eq_deq_seq;
139         unsigned int            eq_size;
140         lnet_eq_handler_t       eq_callback;
141         struct lnet_event       *eq_events;
142         int                     **eq_refs;      /* percpt refcount for EQ */
143 } lnet_eq_t;
144
145 typedef struct lnet_me {
146         struct list_head        me_list;
147         struct lnet_libhandle   me_lh;
148         struct lnet_process_id  me_match_id;
149         unsigned int            me_portal;
150         unsigned int            me_pos;         /* hash offset in mt_hash */
151         __u64                   me_match_bits;
152         __u64                   me_ignore_bits;
153         enum lnet_unlink        me_unlink;
154         struct lnet_libmd      *me_md;
155 } lnet_me_t;
156
157 typedef struct lnet_libmd {
158         struct list_head        md_list;
159         struct lnet_libhandle   md_lh;
160         struct lnet_me         *md_me;
161         char                   *md_start;
162         unsigned int            md_offset;
163         unsigned int            md_length;
164         unsigned int            md_max_size;
165         int                     md_threshold;
166         int                     md_refcount;
167         unsigned int            md_options;
168         unsigned int            md_flags;
169         unsigned int            md_niov;        /* # frags at end of struct */
170         void                   *md_user_ptr;
171         struct lnet_eq         *md_eq;
172         struct lnet_handle_md   md_bulk_handle;
173         union {
174                 struct kvec     iov[LNET_MAX_IOV];
175                 lnet_kiov_t     kiov[LNET_MAX_IOV];
176         } md_iov;
177 } lnet_libmd_t;
178
179 #define LNET_MD_FLAG_ZOMBIE      (1 << 0)
180 #define LNET_MD_FLAG_AUTO_UNLINK (1 << 1)
181 #define LNET_MD_FLAG_ABORTED     (1 << 2)
182
183 typedef struct lnet_test_peer {
184         /* info about peers we are trying to fail */
185         struct list_head        tp_list;        /* ln_test_peers */
186         lnet_nid_t              tp_nid;         /* matching nid */
187         unsigned int            tp_threshold;   /* # failures to simulate */
188 } lnet_test_peer_t;
189
190 #define LNET_COOKIE_TYPE_MD    1
191 #define LNET_COOKIE_TYPE_ME    2
192 #define LNET_COOKIE_TYPE_EQ    3
193 #define LNET_COOKIE_TYPE_BITS  2
194 #define LNET_COOKIE_MASK        ((1ULL << LNET_COOKIE_TYPE_BITS) - 1ULL)
195
196 struct lnet_ni;                                  /* forward ref */
197 struct socket;
198
199 typedef struct lnet_lnd {
200         /* fields managed by portals */
201         struct list_head        lnd_list;       /* stash in the LND table */
202         int                     lnd_refcount;   /* # active instances */
203
204         /* fields initialized by the LND */
205         __u32                   lnd_type;
206
207         int  (*lnd_startup)(struct lnet_ni *ni);
208         void (*lnd_shutdown)(struct lnet_ni *ni);
209         int  (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
210
211         /* In data movement APIs below, payload buffers are described as a set
212          * of 'niov' fragments which are...
213          * EITHER
214          *    in virtual memory (struct kvec *iov != NULL)
215          * OR
216          *    in pages (kernel only: plt_kiov_t *kiov != NULL).
217          * The LND may NOT overwrite these fragment descriptors.
218          * An 'offset' and may specify a byte offset within the set of
219          * fragments to start from
220          */
221
222         /* Start sending a preformatted message.  'private' is NULL for PUT and
223          * GET messages; otherwise this is a response to an incoming message
224          * and 'private' is the 'private' passed to lnet_parse().  Return
225          * non-zero for immediate failure, otherwise complete later with
226          * lnet_finalize() */
227         int (*lnd_send)(struct lnet_ni *ni, void *private,
228                         struct lnet_msg *msg);
229
230         /* Start receiving 'mlen' bytes of payload data, skipping the following
231          * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
232          * lnet_parse().  Return non-zero for immedaite failure, otherwise
233          * complete later with lnet_finalize().  This also gives back a receive
234          * credit if the LND does flow control. */
235         int (*lnd_recv)(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
236                         int delayed, unsigned int niov,
237                         struct kvec *iov, lnet_kiov_t *kiov,
238                         unsigned int offset, unsigned int mlen, unsigned int rlen);
239
240         /* lnet_parse() has had to delay processing of this message
241          * (e.g. waiting for a forwarding buffer or send credits).  Give the
242          * LND a chance to free urgently needed resources.  If called, return 0
243          * for success and do NOT give back a receive credit; that has to wait
244          * until lnd_recv() gets called.  On failure return < 0 and
245          * release resources; lnd_recv() will not be called. */
246         int (*lnd_eager_recv)(struct lnet_ni *ni, void *private,
247                               struct lnet_msg *msg, void **new_privatep);
248
249         /* notification of peer health */
250         void (*lnd_notify)(struct lnet_ni *ni, lnet_nid_t peer, int alive);
251
252         /* query of peer aliveness */
253         void (*lnd_query)(struct lnet_ni *ni, lnet_nid_t peer, cfs_time_t *when);
254
255         /* accept a new connection */
256         int (*lnd_accept)(struct lnet_ni *ni, struct socket *sock);
257 } lnd_t;
258
259 struct lnet_tx_queue {
260         int                     tq_credits;     /* # tx credits free */
261         int                     tq_credits_min; /* lowest it's been */
262         int                     tq_credits_max; /* total # tx credits */
263         struct list_head        tq_delayed;     /* delayed TXs */
264 };
265
266 enum lnet_net_state {
267         /* set when net block is allocated */
268         LNET_NET_STATE_INIT = 0,
269         /* set when NIs in net are started successfully */
270         LNET_NET_STATE_ACTIVE,
271         /* set if all NIs in net are in FAILED state */
272         LNET_NET_STATE_INACTIVE,
273         /* set when shutting down a NET */
274         LNET_NET_STATE_DELETING
275 };
276
277 enum lnet_ni_state {
278         /* set when NI block is allocated */
279         LNET_NI_STATE_INIT = 0,
280         /* set when NI is started successfully */
281         LNET_NI_STATE_ACTIVE,
282         /* set when LND notifies NI failed */
283         LNET_NI_STATE_FAILED,
284         /* set when LND notifies NI degraded */
285         LNET_NI_STATE_DEGRADED,
286         /* set when shuttding down NI */
287         LNET_NI_STATE_DELETING
288 };
289
290 struct lnet_element_stats {
291         atomic_t        send_count;
292         atomic_t        recv_count;
293         atomic_t        drop_count;
294 };
295
296 struct lnet_net {
297         /* chain on the ln_nets */
298         struct list_head        net_list;
299
300         /* net ID, which is composed of
301          * (net_type << 16) | net_num.
302          * net_type can be one of the enumerated types defined in
303          * lnet/include/lnet/nidstr.h */
304         __u32                   net_id;
305
306         /* priority of the network */
307         __u32                   net_prio;
308
309         /* total number of CPTs in the array */
310         __u32                   net_ncpts;
311
312         /* cumulative CPTs of all NIs in this net */
313         __u32                   *net_cpts;
314
315         /* network tunables */
316         struct lnet_ioctl_config_lnd_cmn_tunables net_tunables;
317
318         /*
319          * boolean to indicate that the tunables have been set and
320          * shouldn't be reset
321          */
322         bool                    net_tunables_set;
323
324         /* procedural interface */
325         struct lnet_lnd         *net_lnd;
326
327         /* list of NIs on this net */
328         struct list_head        net_ni_list;
329
330         /* list of NIs being added, but not started yet */
331         struct list_head        net_ni_added;
332
333         /* dying LND instances */
334         struct list_head        net_ni_zombie;
335
336         /* network state */
337         enum lnet_net_state     net_state;
338 };
339
340 typedef struct lnet_ni {
341         /* chain on the lnet_net structure */
342         struct list_head        ni_netlist;
343
344         /* chain on net_ni_cpt */
345         struct list_head        ni_cptlist;
346
347         spinlock_t              ni_lock;
348
349         /* number of CPTs */
350         int                     ni_ncpts;
351
352         /* bond NI on some CPTs */
353         __u32                   *ni_cpts;
354
355         /* interface's NID */
356         lnet_nid_t              ni_nid;
357
358         /* instance-specific data */
359         void                    *ni_data;
360
361         /* per ni credits */
362         atomic_t                ni_tx_credits;
363
364         /* percpt TX queues */
365         struct lnet_tx_queue    **ni_tx_queues;
366
367         /* percpt reference count */
368         int                     **ni_refs;
369
370         /* when I was last alive */
371         long                    ni_last_alive;
372
373         /* pointer to parent network */
374         struct lnet_net         *ni_net;
375
376         /* my health status */
377         struct lnet_ni_status   *ni_status;
378
379         /* NI FSM */
380         enum lnet_ni_state      ni_state;
381
382         /* per NI LND tunables */
383         struct lnet_lnd_tunables ni_lnd_tunables;
384
385         /* lnd tunables set explicitly */
386         bool ni_lnd_tunables_set;
387
388         /* NI statistics */
389         struct lnet_element_stats ni_stats;
390
391         /* physical device CPT */
392         int                     ni_dev_cpt;
393
394         /* sequence number used to round robin over nis within a net */
395         __u32                   ni_seq;
396
397         /*
398          * equivalent interfaces to use
399          * This is an array because socklnd bonding can still be configured
400          */
401         char                    *ni_interfaces[LNET_INTERFACES_NUM];
402         struct net              *ni_net_ns;     /* original net namespace */
403 } lnet_ni_t;
404
405 #define LNET_PROTO_PING_MATCHBITS       0x8000000000000000LL
406
407 /*
408  * Descriptor of a ping info buffer: keep a separate indicator of the
409  * size and a reference count. The type is used both as a source and
410  * sink of data, so we need to keep some information outside of the
411  * area that may be overwritten by network data.
412  */
413 struct lnet_ping_buffer {
414         int                     pb_nnis;
415         atomic_t                pb_refcnt;
416         struct lnet_ping_info   pb_info;
417 };
418
419 #define LNET_PING_BUFFER_SIZE(NNIDS) \
420         offsetof(struct lnet_ping_buffer, pb_info.pi_ni[NNIDS])
421 #define LNET_PING_BUFFER_LONI(PBUF)     ((PBUF)->pb_info.pi_ni[0].ns_nid)
422 #define LNET_PING_BUFFER_SEQNO(PBUF)    ((PBUF)->pb_info.pi_ni[0].ns_status)
423
424
425 /* router checker data, per router */
426 typedef struct lnet_rc_data {
427         /* chain on the_lnet.ln_zombie_rcd or ln_deathrow_rcd */
428         struct list_head        rcd_list;
429         struct lnet_handle_md   rcd_mdh;        /* ping buffer MD */
430         struct lnet_peer_ni     *rcd_gateway;   /* reference to gateway */
431         struct lnet_ping_buffer *rcd_pingbuffer;/* ping buffer */
432         int                     rcd_nnis;       /* desired size of buffer */
433 } lnet_rc_data_t;
434
435 struct lnet_peer_ni {
436         /* chain on peer_net */
437         struct list_head        lpni_on_peer_net_list;
438         /* chain on remote peer list */
439         struct list_head        lpni_on_remote_peer_ni_list;
440         /* chain on peer hash */
441         struct list_head        lpni_hashlist;
442         /* messages blocking for tx credits */
443         struct list_head        lpni_txq;
444         /* messages blocking for router credits */
445         struct list_head        lpni_rtrq;
446         /* chain on router list */
447         struct list_head        lpni_rtr_list;
448         /* pointer to peer net I'm part of */
449         struct lnet_peer_net    *lpni_peer_net;
450         /* statistics kept on each peer NI */
451         struct lnet_element_stats lpni_stats;
452         /* spin lock protecting credits and lpni_txq / lpni_rtrq */
453         spinlock_t              lpni_lock;
454         /* # tx credits available */
455         int                     lpni_txcredits;
456         /* low water mark */
457         int                     lpni_mintxcredits;
458         /* # router credits */
459         int                     lpni_rtrcredits;
460         /* low water mark */
461         int                     lpni_minrtrcredits;
462         /* bytes queued for sending */
463         long                    lpni_txqnob;
464         /* alive/dead? */
465         bool                    lpni_alive;
466         /* notification outstanding? */
467         bool                    lpni_notify;
468         /* outstanding notification for LND? */
469         bool                    lpni_notifylnd;
470         /* some thread is handling notification */
471         bool                    lpni_notifying;
472         /* SEND event outstanding from ping */
473         bool                    lpni_ping_notsent;
474         /* # times router went dead<->alive. Protected with lpni_lock */
475         int                     lpni_alive_count;
476         /* time of last aliveness news */
477         cfs_time_t              lpni_timestamp;
478         /* time of last ping attempt */
479         cfs_time_t              lpni_ping_timestamp;
480         /* != 0 if ping reply expected */
481         cfs_time_t              lpni_ping_deadline;
482         /* when I was last alive */
483         cfs_time_t              lpni_last_alive;
484         /* when lpni_ni was queried last time */
485         cfs_time_t              lpni_last_query;
486         /* network peer is on */
487         struct lnet_net         *lpni_net;
488         /* peer's NID */
489         lnet_nid_t              lpni_nid;
490         /* # refs */
491         atomic_t                lpni_refcount;
492         /* CPT this peer attached on */
493         int                     lpni_cpt;
494         /* state flags -- protected by lpni_lock */
495         unsigned                lpni_state;
496         /* # refs from lnet_route_t::lr_gateway */
497         int                     lpni_rtr_refcount;
498         /* sequence number used to round robin over peer nis within a net */
499         __u32                   lpni_seq;
500         /* sequence number used to round robin over gateways */
501         __u32                   lpni_gw_seq;
502         /* health flag */
503         bool                    lpni_healthy;
504         /* returned RC ping features. Protected with lpni_lock */
505         unsigned int            lpni_ping_feats;
506         /* routes on this peer */
507         struct list_head        lpni_routes;
508         /* array of preferred local nids */
509         lnet_nid_t              *lpni_pref_nids;
510         /* number of preferred NIDs in lnpi_pref_nids */
511         __u32                   lpni_pref_nnids;
512         /* router checker state */
513         struct lnet_rc_data     *lpni_rcd;
514 };
515
516 struct lnet_peer {
517         /* chain on global peer list */
518         struct list_head        lp_on_lnet_peer_list;
519
520         /* list of peer nets */
521         struct list_head        lp_peer_nets;
522
523         /* primary NID of the peer */
524         lnet_nid_t              lp_primary_nid;
525
526         /* lock protecting peer state flags */
527         spinlock_t              lp_lock;
528
529         /* peer state flags */
530         unsigned                lp_state;
531 };
532
533 #define LNET_PEER_MULTI_RAIL    (1 << 0)
534
535 struct lnet_peer_net {
536         /* chain on peer block */
537         struct list_head        lpn_on_peer_list;
538
539         /* list of peer_nis on this network */
540         struct list_head        lpn_peer_nis;
541
542         /* pointer to the peer I'm part of */
543         struct lnet_peer        *lpn_peer;
544
545         /* Net ID */
546         __u32                   lpn_net_id;
547 };
548
549 /* peer hash size */
550 #define LNET_PEER_HASH_BITS     9
551 #define LNET_PEER_HASH_SIZE     (1 << LNET_PEER_HASH_BITS)
552
553 /* peer hash table */
554 struct lnet_peer_table {
555         int                     pt_version;     /* /proc validity stamp */
556         atomic_t                pt_number;      /* # peers extant */
557         struct list_head        *pt_hash;       /* NID->peer hash */
558         struct list_head        pt_zombie_list; /* zombie peers */
559         int                     pt_zombies;     /* # zombie peers */
560         spinlock_t              pt_zombie_lock; /* protect list and count */
561 };
562
563 /* peer aliveness is enabled only on routers for peers in a network where the
564  * struct lnet_ni::ni_peertimeout has been set to a positive value
565  */
566 #define lnet_peer_aliveness_enabled(lp) (the_lnet.ln_routing != 0 && \
567                                         ((lp)->lpni_net) && \
568                                         (lp)->lpni_net->net_tunables.lct_peer_timeout > 0)
569
570 typedef struct lnet_route {
571         struct list_head        lr_list;        /* chain on net */
572         struct list_head        lr_gwlist;      /* chain on gateway */
573         struct lnet_peer_ni     *lr_gateway;    /* router node */
574         __u32                   lr_net;         /* remote network number */
575         int                     lr_seq;         /* sequence for round-robin */
576         unsigned int            lr_downis;      /* number of down NIs */
577         __u32                   lr_hops;        /* how far I am */
578         unsigned int            lr_priority;    /* route priority */
579 } lnet_route_t;
580
581 #define LNET_REMOTE_NETS_HASH_DEFAULT   (1U << 7)
582 #define LNET_REMOTE_NETS_HASH_MAX       (1U << 16)
583 #define LNET_REMOTE_NETS_HASH_SIZE      (1 << the_lnet.ln_remote_nets_hbits)
584
585 typedef struct lnet_remotenet {
586         /* chain on ln_remote_nets_hash */
587         struct list_head        lrn_list;
588         /* routes to me */
589         struct list_head        lrn_routes;
590         /* my net number */
591         __u32                   lrn_net;
592 } lnet_remotenet_t;
593
594 /** lnet message has credit and can be submitted to lnd for send/receive */
595 #define LNET_CREDIT_OK          0
596 /** lnet message is waiting for credit */
597 #define LNET_CREDIT_WAIT        1
598
599 typedef struct lnet_rtrbufpool {
600         /* my free buffer pool */
601         struct list_head        rbp_bufs;
602         /* messages blocking for a buffer */
603         struct list_head        rbp_msgs;
604         /* # pages in each buffer */
605         int                     rbp_npages;
606         /* requested number of buffers */
607         int                     rbp_req_nbuffers;
608         /* # buffers actually allocated */
609         int                     rbp_nbuffers;
610         /* # free buffers / blocked messages */
611         int                     rbp_credits;
612         /* low water mark */
613         int                     rbp_mincredits;
614 } lnet_rtrbufpool_t;
615
616 typedef struct lnet_rtrbuf {
617         struct list_head         rb_list;       /* chain on rbp_bufs */
618         struct lnet_rtrbufpool  *rb_pool;       /* owning pool */
619         lnet_kiov_t              rb_kiov[0];    /* the buffer space */
620 } lnet_rtrbuf_t;
621
622 #define LNET_PEER_HASHSIZE   503                /* prime! */
623
624 enum lnet_match_flags {
625         /* Didn't match anything */
626         LNET_MATCHMD_NONE       = (1 << 0),
627         /* Matched OK */
628         LNET_MATCHMD_OK         = (1 << 1),
629         /* Must be discarded */
630         LNET_MATCHMD_DROP       = (1 << 2),
631         /* match and buffer is exhausted */
632         LNET_MATCHMD_EXHAUSTED  = (1 << 3),
633         /* match or drop */
634         LNET_MATCHMD_FINISH     = (LNET_MATCHMD_OK | LNET_MATCHMD_DROP),
635 };
636
637 /* Options for struct lnet_portal::ptl_options */
638 #define LNET_PTL_LAZY               (1 << 0)
639 #define LNET_PTL_MATCH_UNIQUE       (1 << 1)    /* unique match, for RDMA */
640 #define LNET_PTL_MATCH_WILDCARD     (1 << 2)    /* wildcard match, request portal */
641
642 /* parameter for matching operations (GET, PUT) */
643 struct lnet_match_info {
644         __u64                   mi_mbits;
645         struct lnet_process_id  mi_id;
646         unsigned int            mi_cpt;
647         unsigned int            mi_opc;
648         unsigned int            mi_portal;
649         unsigned int            mi_rlength;
650         unsigned int            mi_roffset;
651 };
652
653 /* ME hash of RDMA portal */
654 #define LNET_MT_HASH_BITS               8
655 #define LNET_MT_HASH_SIZE               (1 << LNET_MT_HASH_BITS)
656 #define LNET_MT_HASH_MASK               (LNET_MT_HASH_SIZE - 1)
657 /* we allocate (LNET_MT_HASH_SIZE + 1) entries for lnet_match_table::mt_hash,
658  * the last entry is reserved for MEs with ignore-bits */
659 #define LNET_MT_HASH_IGNORE             LNET_MT_HASH_SIZE
660 /* __u64 has 2^6 bits, so need 2^(LNET_MT_HASH_BITS - LNET_MT_BITS_U64) which
661  * is 4 __u64s as bit-map, and add an extra __u64 (only use one bit) for the
662  * ME-list with ignore-bits, which is mtable::mt_hash[LNET_MT_HASH_IGNORE] */
663 #define LNET_MT_BITS_U64                6       /* 2^6 bits */
664 #define LNET_MT_EXHAUSTED_BITS          (LNET_MT_HASH_BITS - LNET_MT_BITS_U64)
665 #define LNET_MT_EXHAUSTED_BMAP          ((1 << LNET_MT_EXHAUSTED_BITS) + 1)
666
667 /* portal match table */
668 struct lnet_match_table {
669         /* reserved for upcoming patches, CPU partition ID */
670         unsigned int            mt_cpt;
671         unsigned int            mt_portal;      /* portal index */
672         /* match table is set as "enabled" if there's non-exhausted MD
673          * attached on mt_mhash, it's only valid for wildcard portal */
674         unsigned int            mt_enabled;
675         /* bitmap to flag whether MEs on mt_hash are exhausted or not */
676         __u64                   mt_exhausted[LNET_MT_EXHAUSTED_BMAP];
677         struct list_head        *mt_mhash;      /* matching hash */
678 };
679
680 /* these are only useful for wildcard portal */
681 /* Turn off message rotor for wildcard portals */
682 #define LNET_PTL_ROTOR_OFF      0
683 /* round-robin dispatch all PUT messages for wildcard portals */
684 #define LNET_PTL_ROTOR_ON       1
685 /* round-robin dispatch routed PUT message for wildcard portals */
686 #define LNET_PTL_ROTOR_RR_RT    2
687 /* dispatch routed PUT message by hashing source NID for wildcard portals */
688 #define LNET_PTL_ROTOR_HASH_RT  3
689
690 typedef struct lnet_portal {
691         spinlock_t              ptl_lock;
692         unsigned int            ptl_index;      /* portal ID, reserved */
693         /* flags on this portal: lazy, unique... */
694         unsigned int            ptl_options;
695         /* list of messages which are stealing buffer */
696         struct list_head        ptl_msg_stealing;
697         /* messages blocking for MD */
698         struct list_head        ptl_msg_delayed;
699         /* Match table for each CPT */
700         struct lnet_match_table **ptl_mtables;
701         /* spread rotor of incoming "PUT" */
702         unsigned int            ptl_rotor;
703         /* # active entries for this portal */
704         int                     ptl_mt_nmaps;
705         /* array of active entries' cpu-partition-id */
706         int                     ptl_mt_maps[0];
707 } lnet_portal_t;
708
709 #define LNET_LH_HASH_BITS       12
710 #define LNET_LH_HASH_SIZE       (1ULL << LNET_LH_HASH_BITS)
711 #define LNET_LH_HASH_MASK       (LNET_LH_HASH_SIZE - 1)
712
713 /* resource container (ME, MD, EQ) */
714 struct lnet_res_container {
715         unsigned int            rec_type;       /* container type */
716         __u64                   rec_lh_cookie;  /* cookie generator */
717         struct list_head        rec_active;     /* active resource list */
718         struct list_head        *rec_lh_hash;   /* handle hash */
719 };
720
721 /* message container */
722 struct lnet_msg_container {
723         int                     msc_init;       /* initialized or not */
724         /* max # threads finalizing */
725         int                     msc_nfinalizers;
726         /* msgs waiting to complete finalizing */
727         struct list_head        msc_finalizing;
728         struct list_head        msc_active;     /* active message list */
729         /* threads doing finalization */
730         void                    **msc_finalizers;
731 };
732
733 /* Router Checker states */
734 #define LNET_RC_STATE_SHUTDOWN          0       /* not started */
735 #define LNET_RC_STATE_RUNNING           1       /* started up OK */
736 #define LNET_RC_STATE_STOPPING          2       /* telling thread to stop */
737
738 /* LNet states */
739 #define LNET_STATE_SHUTDOWN             0       /* not started */
740 #define LNET_STATE_RUNNING              1       /* started up OK */
741 #define LNET_STATE_STOPPING             2       /* telling thread to stop */
742
743 typedef struct lnet {
744         /* CPU partition table of LNet */
745         struct cfs_cpt_table            *ln_cpt_table;
746         /* number of CPTs in ln_cpt_table */
747         unsigned int                    ln_cpt_number;
748         unsigned int                    ln_cpt_bits;
749
750         /* protect LNet resources (ME/MD/EQ) */
751         struct cfs_percpt_lock          *ln_res_lock;
752         /* # portals */
753         int                             ln_nportals;
754         /* the vector of portals */
755         struct lnet_portal              **ln_portals;
756         /* percpt ME containers */
757         struct lnet_res_container       **ln_me_containers;
758         /* percpt MD container */
759         struct lnet_res_container       **ln_md_containers;
760
761         /* Event Queue container */
762         struct lnet_res_container       ln_eq_container;
763         wait_queue_head_t               ln_eq_waitq;
764         spinlock_t                      ln_eq_wait_lock;
765
766         unsigned int                    ln_remote_nets_hbits;
767
768         /* protect NI, peer table, credits, routers, rtrbuf... */
769         struct cfs_percpt_lock          *ln_net_lock;
770         /* percpt message containers for active/finalizing/freed message */
771         struct lnet_msg_container       **ln_msg_containers;
772         struct lnet_counters            **ln_counters;
773         struct lnet_peer_table          **ln_peer_tables;
774         /* list of configured or discovered peers */
775         struct list_head                ln_peers;
776         /* list of peer nis not on a local network */
777         struct list_head                ln_remote_peer_ni_list;
778         /* failure simulation */
779         struct list_head                ln_test_peers;
780         struct list_head                ln_drop_rules;
781         struct list_head                ln_delay_rules;
782         /* LND instances */
783         struct list_head                ln_nets;
784         /* the loopback NI */
785         struct lnet_ni                  *ln_loni;
786         /* network zombie list */
787         struct list_head                ln_net_zombie;
788
789         /* remote networks with routes to them */
790         struct list_head                *ln_remote_nets_hash;
791         /* validity stamp */
792         __u64                           ln_remote_nets_version;
793         /* list of all known routers */
794         struct list_head                ln_routers;
795         /* validity stamp */
796         __u64                           ln_routers_version;
797         /* percpt router buffer pools */
798         struct lnet_rtrbufpool          **ln_rtrpools;
799
800         /*
801          * Ping target / Push source
802          *
803          * The ping target and push source share a single buffer. The
804          * ln_ping_target is protected against concurrent updates by
805          * ln_api_mutex.
806          */
807         struct lnet_handle_md           ln_ping_target_md;
808         struct lnet_handle_eq           ln_ping_target_eq;
809         struct lnet_ping_buffer         *ln_ping_target;
810         atomic_t                        ln_ping_target_seqno;
811
812         /* router checker startup/shutdown state */
813         int                             ln_rc_state;
814         /* router checker's event queue */
815         struct lnet_handle_eq           ln_rc_eqh;
816         /* rcd still pending on net */
817         struct list_head                ln_rcd_deathrow;
818         /* rcd ready for free */
819         struct list_head                ln_rcd_zombie;
820         /* serialise startup/shutdown */
821         struct semaphore                ln_rc_signal;
822
823         struct mutex                    ln_api_mutex;
824         struct mutex                    ln_lnd_mutex;
825         /* Have I called LNetNIInit myself? */
826         int                             ln_niinit_self;
827         /* LNetNIInit/LNetNIFini counter */
828         int                             ln_refcount;
829         /* SHUTDOWN/RUNNING/STOPPING */
830         int                             ln_state;
831
832         int                             ln_routing;     /* am I a router? */
833         lnet_pid_t                      ln_pid;         /* requested pid */
834         /* uniquely identifies this ni in this epoch */
835         __u64                           ln_interface_cookie;
836         /* registered LNDs */
837         struct list_head                ln_lnds;
838
839         /* test protocol compatibility flags */
840         int                             ln_testprotocompat;
841
842         /* 0 - load the NIs from the mod params
843          * 1 - do not load the NIs from the mod params
844          * Reverse logic to ensure that other calls to LNetNIInit
845          * need no change
846          */
847         bool                            ln_nis_from_mod_params;
848
849         /* waitq for router checker.  As long as there are no routes in
850          * the list, the router checker will sleep on this queue.  when
851          * routes are added the thread will wake up */
852         wait_queue_head_t               ln_rc_waitq;
853 } lnet_t;
854
855 #endif