Whamcloud - gitweb
LU-10157 lnet: restore an maximal fragments count
[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, 2017, 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/semaphore.h>
48 #include <linux/types.h>
49
50 #include <uapi/linux/lnet/lnet-dlc.h>
51 #include <uapi/linux/lnet/lnetctl.h>
52 #include <uapi/linux/lnet/nidstr.h>
53
54 /* Max payload size */
55 #define LNET_MAX_PAYLOAD        LNET_MTU
56
57 /** limit on the number of fragments in discontiguous MDs */
58 #define LNET_MAX_IOV    256
59
60 /*
61  * This is the maximum health value.
62  * All local and peer NIs created have their health default to this value.
63  */
64 #define LNET_MAX_HEALTH_VALUE 1000
65
66 /* forward refs */
67 struct lnet_libmd;
68
69 enum lnet_msg_hstatus {
70         LNET_MSG_STATUS_OK = 0,
71         LNET_MSG_STATUS_LOCAL_INTERRUPT,
72         LNET_MSG_STATUS_LOCAL_DROPPED,
73         LNET_MSG_STATUS_LOCAL_ABORTED,
74         LNET_MSG_STATUS_LOCAL_NO_ROUTE,
75         LNET_MSG_STATUS_LOCAL_ERROR,
76         LNET_MSG_STATUS_LOCAL_TIMEOUT,
77         LNET_MSG_STATUS_REMOTE_ERROR,
78         LNET_MSG_STATUS_REMOTE_DROPPED,
79         LNET_MSG_STATUS_REMOTE_TIMEOUT,
80         LNET_MSG_STATUS_NETWORK_TIMEOUT,
81         LNET_MSG_STATUS_END,
82 };
83
84 struct lnet_rsp_tracker {
85         /* chain on the waiting list */
86         struct list_head rspt_on_list;
87         /* cpt to lock */
88         int rspt_cpt;
89         /* nid of next hop */
90         lnet_nid_t rspt_next_hop_nid;
91         /* deadline of the REPLY/ACK */
92         ktime_t rspt_deadline;
93         /* parent MD */
94         struct lnet_handle_md rspt_mdh;
95 };
96
97 struct lnet_msg {
98         struct list_head        msg_activelist;
99         struct list_head        msg_list;       /* Q for credits/MD */
100
101         struct lnet_process_id  msg_target;
102         /* Primary NID of the source. */
103         lnet_nid_t              msg_initiator;
104         /* where is it from, it's only for building event */
105         lnet_nid_t              msg_from;
106         __u32                   msg_type;
107
108         /*
109          * hold parameters in case message is with held due
110          * to discovery
111          */
112         lnet_nid_t              msg_src_nid_param;
113         lnet_nid_t              msg_rtr_nid_param;
114
115         /*
116          * Deadline for the message after which it will be finalized if it
117          * has not completed.
118          */
119         ktime_t                 msg_deadline;
120
121         /* The message health status. */
122         enum lnet_msg_hstatus   msg_health_status;
123         /* This is a recovery message */
124         bool                    msg_recovery;
125         /* the number of times a transmission has been retried */
126         int                     msg_retry_count;
127         /* flag to indicate that we do not want to resend this message */
128         bool                    msg_no_resend;
129
130         /* committed for sending */
131         unsigned int            msg_tx_committed:1;
132         /* CPT # this message committed for sending */
133         unsigned int            msg_tx_cpt:15;
134         /* committed for receiving */
135         unsigned int            msg_rx_committed:1;
136         /* CPT # this message committed for receiving */
137         unsigned int            msg_rx_cpt:15;
138         /* queued for tx credit */
139         unsigned int            msg_tx_delayed:1;
140         /* queued for RX buffer */
141         unsigned int            msg_rx_delayed:1;
142         /* ready for pending on RX delay list */
143         unsigned int            msg_rx_ready_delay:1;
144
145         unsigned int          msg_vmflush:1;      /* VM trying to free memory */
146         unsigned int          msg_target_is_router:1; /* sending to a router */
147         unsigned int          msg_routing:1;      /* being forwarded */
148         unsigned int          msg_ack:1;          /* ack on finalize (PUT) */
149         unsigned int          msg_sending:1;      /* outgoing message */
150         unsigned int          msg_receiving:1;    /* being received */
151         unsigned int          msg_txcredit:1;     /* taken an NI send credit */
152         unsigned int          msg_peertxcredit:1; /* taken a peer send credit */
153         unsigned int          msg_rtrcredit:1;    /* taken a globel router credit */
154         unsigned int          msg_peerrtrcredit:1; /* taken a peer router credit */
155         unsigned int          msg_onactivelist:1; /* on the activelist */
156         unsigned int          msg_rdma_get:1;
157
158         struct lnet_peer_ni  *msg_txpeer;         /* peer I'm sending to */
159         struct lnet_peer_ni  *msg_rxpeer;         /* peer I received from */
160
161         void                 *msg_private;
162         struct lnet_libmd    *msg_md;
163         /* the NI the message was sent or received over */
164         struct lnet_ni       *msg_txni;
165         struct lnet_ni       *msg_rxni;
166
167         unsigned int          msg_len;
168         unsigned int          msg_wanted;
169         unsigned int          msg_offset;
170         unsigned int          msg_niov;
171         struct bio_vec       *msg_kiov;
172
173         struct lnet_event       msg_ev;
174         struct lnet_hdr         msg_hdr;
175 };
176
177 struct lnet_libhandle {
178         struct list_head        lh_hash_chain;
179         __u64                   lh_cookie;
180 };
181
182 #define lh_entry(ptr, type, member) \
183         ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
184
185 struct lnet_me {
186         struct list_head        me_list;
187         int                     me_cpt;
188         struct lnet_process_id  me_match_id;
189         unsigned int            me_portal;
190         unsigned int            me_pos;         /* hash offset in mt_hash */
191         __u64                   me_match_bits;
192         __u64                   me_ignore_bits;
193         enum lnet_unlink        me_unlink;
194         struct lnet_libmd      *me_md;
195 };
196
197 struct lnet_libmd {
198         struct list_head         md_list;
199         struct lnet_libhandle    md_lh;
200         struct lnet_me          *md_me;
201         char                    *md_start;
202         unsigned int             md_offset;
203         unsigned int             md_length;
204         unsigned int             md_max_size;
205         int                      md_threshold;
206         int                      md_refcount;
207         unsigned int             md_options;
208         unsigned int             md_flags;
209         unsigned int             md_niov;       /* # frags at end of struct */
210         void                    *md_user_ptr;
211         struct lnet_rsp_tracker *md_rspt_ptr;
212         lnet_handler_t           md_handler;
213         struct lnet_handle_md    md_bulk_handle;
214         struct bio_vec           md_kiov[LNET_MAX_IOV];
215 };
216
217 #define LNET_MD_FLAG_ZOMBIE      BIT(0)
218 #define LNET_MD_FLAG_AUTO_UNLINK BIT(1)
219 #define LNET_MD_FLAG_ABORTED     BIT(2)
220
221 struct lnet_test_peer {
222         /* info about peers we are trying to fail */
223         struct list_head        tp_list;        /* ln_test_peers */
224         lnet_nid_t              tp_nid;         /* matching nid */
225         unsigned int            tp_threshold;   /* # failures to simulate */
226 };
227
228 #define LNET_COOKIE_TYPE_MD    1
229 #define LNET_COOKIE_TYPE_ME    2
230 #define LNET_COOKIE_TYPE_EQ    3
231 #define LNET_COOKIE_TYPE_BITS  2
232 #define LNET_COOKIE_MASK        ((1ULL << LNET_COOKIE_TYPE_BITS) - 1ULL)
233
234 struct lnet_ni;                                  /* forward ref */
235 struct socket;
236
237 struct lnet_lnd {
238         /* fields initialized by the LND */
239         __u32                   lnd_type;
240
241         int  (*lnd_startup)(struct lnet_ni *ni);
242         void (*lnd_shutdown)(struct lnet_ni *ni);
243         int  (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
244
245         /* In data movement APIs below, payload buffers are described as a set
246          * of 'niov' fragments which are in pages.
247          * The LND may NOT overwrite these fragment descriptors.
248          * An 'offset' and may specify a byte offset within the set of
249          * fragments to start from
250          */
251
252         /* Start sending a preformatted message.  'private' is NULL for PUT and
253          * GET messages; otherwise this is a response to an incoming message
254          * and 'private' is the 'private' passed to lnet_parse().  Return
255          * non-zero for immediate failure, otherwise complete later with
256          * lnet_finalize() */
257         int (*lnd_send)(struct lnet_ni *ni, void *private,
258                         struct lnet_msg *msg);
259
260         /* Start receiving 'mlen' bytes of payload data, skipping the following
261          * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
262          * lnet_parse().  Return non-zero for immedaite failure, otherwise
263          * complete later with lnet_finalize().  This also gives back a receive
264          * credit if the LND does flow control. */
265         int (*lnd_recv)(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
266                         int delayed, unsigned int niov,
267                         struct bio_vec *kiov,
268                         unsigned int offset, unsigned int mlen, unsigned int rlen);
269
270         /* lnet_parse() has had to delay processing of this message
271          * (e.g. waiting for a forwarding buffer or send credits).  Give the
272          * LND a chance to free urgently needed resources.  If called, return 0
273          * for success and do NOT give back a receive credit; that has to wait
274          * until lnd_recv() gets called.  On failure return < 0 and
275          * release resources; lnd_recv() will not be called. */
276         int (*lnd_eager_recv)(struct lnet_ni *ni, void *private,
277                               struct lnet_msg *msg, void **new_privatep);
278
279         /* notification of peer down */
280         void (*lnd_notify_peer_down)(lnet_nid_t peer);
281
282         /* accept a new connection */
283         int (*lnd_accept)(struct lnet_ni *ni, struct socket *sock);
284 };
285
286 struct lnet_tx_queue {
287         int                     tq_credits;     /* # tx credits free */
288         int                     tq_credits_min; /* lowest it's been */
289         int                     tq_credits_max; /* total # tx credits */
290         struct list_head        tq_delayed;     /* delayed TXs */
291 };
292
293 enum lnet_net_state {
294         /* set when net block is allocated */
295         LNET_NET_STATE_INIT = 0,
296         /* set when NIs in net are started successfully */
297         LNET_NET_STATE_ACTIVE,
298         /* set if all NIs in net are in FAILED state */
299         LNET_NET_STATE_INACTIVE,
300         /* set when shutting down a NET */
301         LNET_NET_STATE_DELETING
302 };
303
304 enum lnet_ni_state {
305         /* initial state when NI is created */
306         LNET_NI_STATE_INIT = 0,
307         /* set when NI is brought up */
308         LNET_NI_STATE_ACTIVE,
309         /* set when NI is being shutdown */
310         LNET_NI_STATE_DELETING,
311 };
312
313 #define LNET_NI_RECOVERY_PENDING        BIT(0)
314 #define LNET_NI_RECOVERY_FAILED         BIT(1)
315
316 enum lnet_stats_type {
317         LNET_STATS_TYPE_SEND = 0,
318         LNET_STATS_TYPE_RECV,
319         LNET_STATS_TYPE_DROP
320 };
321
322 struct lnet_comm_count {
323         atomic_t co_get_count;
324         atomic_t co_put_count;
325         atomic_t co_reply_count;
326         atomic_t co_ack_count;
327         atomic_t co_hello_count;
328 };
329
330 struct lnet_element_stats {
331         struct lnet_comm_count el_send_stats;
332         struct lnet_comm_count el_recv_stats;
333         struct lnet_comm_count el_drop_stats;
334 };
335
336 struct lnet_health_local_stats {
337         atomic_t hlt_local_interrupt;
338         atomic_t hlt_local_dropped;
339         atomic_t hlt_local_aborted;
340         atomic_t hlt_local_no_route;
341         atomic_t hlt_local_timeout;
342         atomic_t hlt_local_error;
343 };
344
345 struct lnet_health_remote_stats {
346         atomic_t hlt_remote_dropped;
347         atomic_t hlt_remote_timeout;
348         atomic_t hlt_remote_error;
349         atomic_t hlt_network_timeout;
350 };
351
352 struct lnet_net {
353         /* chain on the ln_nets */
354         struct list_head        net_list;
355
356         /* net ID, which is composed of
357          * (net_type << 16) | net_num.
358          * net_type can be one of the enumerated types defined in
359          * lnet/include/lnet/nidstr.h */
360         __u32                   net_id;
361
362         /* priority of the network */
363         __u32                   net_prio;
364
365         /* total number of CPTs in the array */
366         __u32                   net_ncpts;
367
368         /* cumulative CPTs of all NIs in this net */
369         __u32                   *net_cpts;
370
371         /* network tunables */
372         struct lnet_ioctl_config_lnd_cmn_tunables net_tunables;
373
374         /*
375          * boolean to indicate that the tunables have been set and
376          * shouldn't be reset
377          */
378         bool                    net_tunables_set;
379
380         /* procedural interface */
381         const struct lnet_lnd   *net_lnd;
382
383         /* list of NIs on this net */
384         struct list_head        net_ni_list;
385
386         /* list of NIs being added, but not started yet */
387         struct list_head        net_ni_added;
388
389         /* dying LND instances */
390         struct list_head        net_ni_zombie;
391
392         /* when I was last alive */
393         time64_t                net_last_alive;
394
395         /* protects access to net_last_alive */
396         spinlock_t              net_lock;
397 };
398
399 struct lnet_ni {
400         /* chain on the lnet_net structure */
401         struct list_head        ni_netlist;
402
403         /* chain on the recovery queue */
404         struct list_head        ni_recovery;
405
406         /* MD handle for recovery ping */
407         struct lnet_handle_md   ni_ping_mdh;
408
409         spinlock_t              ni_lock;
410
411         /* number of CPTs */
412         int                     ni_ncpts;
413
414         /* bond NI on some CPTs */
415         __u32                   *ni_cpts;
416
417         /* interface's NID */
418         lnet_nid_t              ni_nid;
419
420         /* instance-specific data */
421         void                    *ni_data;
422
423         /* per ni credits */
424         atomic_t                ni_tx_credits;
425
426         /* percpt TX queues */
427         struct lnet_tx_queue    **ni_tx_queues;
428
429         /* percpt reference count */
430         int                     **ni_refs;
431
432         /* pointer to parent network */
433         struct lnet_net         *ni_net;
434
435         /* my health status */
436         struct lnet_ni_status   *ni_status;
437
438         /* NI FSM. Protected by lnet_ni_lock() */
439         enum lnet_ni_state      ni_state;
440
441         /* Recovery state. Protected by lnet_ni_lock() */
442         __u32                   ni_recovery_state;
443
444         /* per NI LND tunables */
445         struct lnet_lnd_tunables ni_lnd_tunables;
446
447         /* lnd tunables set explicitly */
448         bool ni_lnd_tunables_set;
449
450         /* NI statistics */
451         struct lnet_element_stats ni_stats;
452         struct lnet_health_local_stats ni_hstats;
453
454         /* physical device CPT */
455         int                     ni_dev_cpt;
456
457         /* sequence number used to round robin over nis within a net */
458         __u32                   ni_seq;
459
460         /*
461          * health value
462          *      initialized to LNET_MAX_HEALTH_VALUE
463          * Value is decremented every time we fail to send a message over
464          * this NI because of a NI specific failure.
465          * Value is incremented if we successfully send a message.
466          */
467         atomic_t                ni_healthv;
468
469         /*
470          * Set to 1 by the LND when it receives an event telling it the device
471          * has gone into a fatal state. Set to 0 when the LND receives an
472          * even telling it the device is back online.
473          */
474         atomic_t                ni_fatal_error_on;
475
476         /*
477          * equivalent interfaces to use
478          * This is an array because socklnd bonding can still be configured
479          */
480         char                    *ni_interfaces[LNET_INTERFACES_NUM];
481         struct net              *ni_net_ns;     /* original net namespace */
482 };
483
484 #define LNET_PROTO_PING_MATCHBITS       0x8000000000000000LL
485
486 /*
487  * Descriptor of a ping info buffer: keep a separate indicator of the
488  * size and a reference count. The type is used both as a source and
489  * sink of data, so we need to keep some information outside of the
490  * area that may be overwritten by network data.
491  */
492 struct lnet_ping_buffer {
493         int                     pb_nnis;
494         atomic_t                pb_refcnt;
495         bool                    pb_needs_post;
496         struct lnet_ping_info   pb_info;
497 };
498
499 #define LNET_PING_BUFFER_SIZE(NNIDS) \
500         offsetof(struct lnet_ping_buffer, pb_info.pi_ni[NNIDS])
501 #define LNET_PING_BUFFER_LONI(PBUF)     ((PBUF)->pb_info.pi_ni[0].ns_nid)
502 #define LNET_PING_BUFFER_SEQNO(PBUF)    ((PBUF)->pb_info.pi_ni[0].ns_status)
503
504 #define LNET_PING_INFO_TO_BUFFER(PINFO) \
505         container_of((PINFO), struct lnet_ping_buffer, pb_info)
506
507 struct lnet_peer_ni {
508         /* chain on lpn_peer_nis */
509         struct list_head        lpni_peer_nis;
510         /* chain on remote peer list */
511         struct list_head        lpni_on_remote_peer_ni_list;
512         /* chain on recovery queue */
513         struct list_head        lpni_recovery;
514         /* chain on peer hash */
515         struct list_head        lpni_hashlist;
516         /* messages blocking for tx credits */
517         struct list_head        lpni_txq;
518         /* pointer to peer net I'm part of */
519         struct lnet_peer_net    *lpni_peer_net;
520         /* statistics kept on each peer NI */
521         struct lnet_element_stats lpni_stats;
522         struct lnet_health_remote_stats lpni_hstats;
523         /* spin lock protecting credits and lpni_txq */
524         spinlock_t              lpni_lock;
525         /* # tx credits available */
526         int                     lpni_txcredits;
527         /* low water mark */
528         int                     lpni_mintxcredits;
529         /*
530          * Each peer_ni in a gateway maintains its own credits. This
531          * allows more traffic to gateways that have multiple interfaces.
532          */
533         /* # router credits */
534         int                     lpni_rtrcredits;
535         /* low water mark */
536         int                     lpni_minrtrcredits;
537         /* bytes queued for sending */
538         long                    lpni_txqnob;
539         /* network peer is on */
540         struct lnet_net         *lpni_net;
541         /* peer's NID */
542         lnet_nid_t              lpni_nid;
543         /* # refs */
544         atomic_t                lpni_refcount;
545         /* health value for the peer */
546         atomic_t                lpni_healthv;
547         /* recovery ping mdh */
548         struct lnet_handle_md   lpni_recovery_ping_mdh;
549         /* CPT this peer attached on */
550         int                     lpni_cpt;
551         /* state flags -- protected by lpni_lock */
552         unsigned                lpni_state;
553         /* status of the peer NI as reported by the peer */
554         __u32                   lpni_ns_status;
555         /* sequence number used to round robin over peer nis within a net */
556         __u32                   lpni_seq;
557         /* sequence number used to round robin over gateways */
558         __u32                   lpni_gw_seq;
559         /* returned RC ping features. Protected with lpni_lock */
560         unsigned int            lpni_ping_feats;
561         /* time last message was received from the peer */
562         time64_t                lpni_last_alive;
563         /* preferred local nids: if only one, use lpni_pref.nid */
564         union lpni_pref {
565                 lnet_nid_t      nid;
566                 lnet_nid_t      *nids;
567         } lpni_pref;
568         /* number of preferred NIDs in lnpi_pref_nids */
569         __u32                   lpni_pref_nnids;
570 };
571
572 /* Preferred path added due to traffic on non-MR peer_ni */
573 #define LNET_PEER_NI_NON_MR_PREF        BIT(0)
574 /* peer is being recovered. */
575 #define LNET_PEER_NI_RECOVERY_PENDING   BIT(1)
576 /* recovery ping failed */
577 #define LNET_PEER_NI_RECOVERY_FAILED    BIT(2)
578 /* peer is being deleted */
579 #define LNET_PEER_NI_DELETING           BIT(3)
580
581 struct lnet_peer {
582         /* chain on pt_peer_list */
583         struct list_head        lp_peer_list;
584
585         /* list of peer nets */
586         struct list_head        lp_peer_nets;
587
588         /* list of messages pending discovery*/
589         struct list_head        lp_dc_pendq;
590
591         /* chain on router list */
592         struct list_head        lp_rtr_list;
593
594         /* primary NID of the peer */
595         lnet_nid_t              lp_primary_nid;
596
597         /* source NID to use during discovery */
598         lnet_nid_t              lp_disc_src_nid;
599
600         /* net to perform discovery on */
601         __u32                   lp_disc_net_id;
602
603         /* CPT of peer_table */
604         int                     lp_cpt;
605
606         /* number of NIDs on this peer */
607         int                     lp_nnis;
608
609         /* # refs from lnet_route::lr_gateway */
610         int                     lp_rtr_refcount;
611
612         /*
613          * peer specific health sensitivity value to decrement peer nis in
614          * this peer with if set to something other than 0
615          */
616         __u32                   lp_health_sensitivity;
617
618         /* messages blocking for router credits */
619         struct list_head        lp_rtrq;
620
621         /* routes on this peer */
622         struct list_head        lp_routes;
623
624         /* reference count */
625         atomic_t                lp_refcount;
626
627         /* lock protecting peer state flags and lpni_rtrq */
628         spinlock_t              lp_lock;
629
630         /* peer state flags */
631         unsigned                lp_state;
632
633         /* buffer for data pushed by peer */
634         struct lnet_ping_buffer *lp_data;
635
636         /* MD handle for ping in progress */
637         struct lnet_handle_md   lp_ping_mdh;
638
639         /* MD handle for push in progress */
640         struct lnet_handle_md   lp_push_mdh;
641
642         /* number of NIDs for sizing push data */
643         int                     lp_data_nnis;
644
645         /* NI config sequence number of peer */
646         __u32                   lp_peer_seqno;
647
648         /* Local NI config sequence number acked by peer */
649         __u32                   lp_node_seqno;
650
651         /* Local NI config sequence number sent to peer */
652         __u32                   lp_node_seqno_sent;
653
654         /* Ping error encountered during discovery. */
655         int                     lp_ping_error;
656
657         /* Push error encountered during discovery. */
658         int                     lp_push_error;
659
660         /* Error encountered during discovery. */
661         int                     lp_dc_error;
662
663         /* time it was put on the ln_dc_working queue */
664         time64_t                lp_last_queued;
665
666         /* link on discovery-related lists */
667         struct list_head        lp_dc_list;
668
669         /* tasks waiting on discovery of this peer */
670         wait_queue_head_t       lp_dc_waitq;
671
672         /* cached peer aliveness */
673         bool                    lp_alive;
674 };
675
676 /*
677  * The status flags in lp_state. Their semantics have chosen so that
678  * lp_state can be zero-initialized.
679  *
680  * A peer is marked MULTI_RAIL in two cases: it was configured using DLC
681  * as multi-rail aware, or the LNET_PING_FEAT_MULTI_RAIL bit was set.
682  *
683  * A peer is marked NO_DISCOVERY if the LNET_PING_FEAT_DISCOVERY bit was
684  * NOT set when the peer was pinged by discovery.
685  *
686  * A peer is marked ROUTER if it indicates so in the feature bit.
687  */
688 #define LNET_PEER_MULTI_RAIL            BIT(0)  /* Multi-rail aware */
689 #define LNET_PEER_NO_DISCOVERY          BIT(1)  /* Peer disabled discovery */
690 #define LNET_PEER_ROUTER_ENABLED        BIT(2)  /* router feature enabled */
691
692 /*
693  * A peer is marked CONFIGURED if it was configured by DLC.
694  *
695  * In addition, a peer is marked DISCOVERED if it has fully passed
696  * through Peer Discovery.
697  *
698  * When Peer Discovery is disabled, the discovery thread will mark
699  * peers REDISCOVER to indicate that they should be re-examined if
700  * discovery is (re)enabled on the node.
701  *
702  * A peer that was created as the result of inbound traffic will not
703  * be marked at all.
704  */
705 #define LNET_PEER_CONFIGURED            BIT(3)  /* Configured via DLC */
706 #define LNET_PEER_DISCOVERED            BIT(4)  /* Peer was discovered */
707 #define LNET_PEER_REDISCOVER            BIT(5)  /* Discovery was disabled */
708 /*
709  * A peer is marked DISCOVERING when discovery is in progress.
710  * The other flags below correspond to stages of discovery.
711  */
712 #define LNET_PEER_DISCOVERING           BIT(6)  /* Discovering */
713 #define LNET_PEER_DATA_PRESENT          BIT(7)  /* Remote peer data present */
714 #define LNET_PEER_NIDS_UPTODATE         BIT(8)  /* Remote peer info uptodate */
715 #define LNET_PEER_PING_SENT             BIT(9)  /* Waiting for REPLY to Ping */
716 #define LNET_PEER_PUSH_SENT             BIT(10) /* Waiting for ACK of Push */
717 #define LNET_PEER_PING_FAILED           BIT(11) /* Ping send failure */
718 #define LNET_PEER_PUSH_FAILED           BIT(12) /* Push send failure */
719 /*
720  * A ping can be forced as a way to fix up state, or as a manual
721  * intervention by an admin.
722  * A push can be forced in circumstances that would normally not
723  * allow for one to happen.
724  */
725 #define LNET_PEER_FORCE_PING            BIT(13) /* Forced Ping */
726 #define LNET_PEER_FORCE_PUSH            BIT(14) /* Forced Push */
727
728 /* force delete even if router */
729 #define LNET_PEER_RTR_NI_FORCE_DEL      BIT(15)
730
731 /* gw undergoing alive discovery */
732 #define LNET_PEER_RTR_DISCOVERY         BIT(16)
733 /* gw has undergone discovery (does not indicate success or failure) */
734 #define LNET_PEER_RTR_DISCOVERED        BIT(17)
735
736 /* peer is marked for deletion */
737 #define LNET_PEER_MARK_DELETION         BIT(18)
738
739 struct lnet_peer_net {
740         /* chain on lp_peer_nets */
741         struct list_head        lpn_peer_nets;
742
743         /* list of peer_nis on this network */
744         struct list_head        lpn_peer_nis;
745
746         /* pointer to the peer I'm part of */
747         struct lnet_peer        *lpn_peer;
748
749         /* Net ID */
750         __u32                   lpn_net_id;
751
752         /* peer net health */
753         int                     lpn_healthv;
754
755         /* time of last router net check attempt */
756         time64_t                lpn_rtrcheck_timestamp;
757
758         /* selection sequence number */
759         __u32                   lpn_seq;
760
761         /* reference count */
762         atomic_t                lpn_refcount;
763 };
764
765 /* peer hash size */
766 #define LNET_PEER_HASH_BITS     9
767 #define LNET_PEER_HASH_SIZE     (1 << LNET_PEER_HASH_BITS)
768
769 /*
770  * peer hash table - one per CPT
771  *
772  * protected by lnet_net_lock/EX for update
773  *    pt_version
774  *    pt_hash[...]
775  *    pt_peer_list
776  *    pt_peers
777  * protected by pt_zombie_lock:
778  *    pt_zombie_list
779  *    pt_zombies
780  *
781  * pt_zombie lock nests inside lnet_net_lock
782  */
783 struct lnet_peer_table {
784         int                     pt_version;     /* /proc validity stamp */
785         struct list_head        *pt_hash;       /* NID->peer hash */
786         struct list_head        pt_peer_list;   /* peers */
787         int                     pt_peers;       /* # peers */
788         struct list_head        pt_zombie_list; /* zombie peer_ni */
789         int                     pt_zombies;     /* # zombie peers_ni */
790         spinlock_t              pt_zombie_lock; /* protect list and count */
791 };
792
793 /* peer aliveness is enabled only on routers for peers in a network where the
794  * struct lnet_ni::ni_peertimeout has been set to a positive value
795  */
796 #define lnet_peer_aliveness_enabled(lp) (the_lnet.ln_routing != 0 && \
797                                         ((lp)->lpni_net) && \
798                                         (lp)->lpni_net->net_tunables.lct_peer_timeout > 0)
799
800 struct lnet_route {
801         struct list_head        lr_list;        /* chain on net */
802         struct list_head        lr_gwlist;      /* chain on gateway */
803         struct lnet_peer        *lr_gateway;    /* router node */
804         lnet_nid_t              lr_nid;         /* NID used to add route */
805         __u32                   lr_net;         /* remote network number */
806         __u32                   lr_lnet;        /* local network number */
807         int                     lr_seq;         /* sequence for round-robin */
808         __u32                   lr_hops;        /* how far I am */
809         unsigned int            lr_priority;    /* route priority */
810         bool                    lr_alive;       /* cached route aliveness */
811         bool                    lr_single_hop;  /* this route is single-hop */
812 };
813
814 #define LNET_REMOTE_NETS_HASH_DEFAULT   (1U << 7)
815 #define LNET_REMOTE_NETS_HASH_MAX       (1U << 16)
816 #define LNET_REMOTE_NETS_HASH_SIZE      (1 << the_lnet.ln_remote_nets_hbits)
817
818 struct lnet_remotenet {
819         /* chain on ln_remote_nets_hash */
820         struct list_head        lrn_list;
821         /* routes to me */
822         struct list_head        lrn_routes;
823         /* my net number */
824         __u32                   lrn_net;
825 };
826
827 /** lnet message has credit and can be submitted to lnd for send/receive */
828 #define LNET_CREDIT_OK          0
829 /** lnet message is waiting for credit */
830 #define LNET_CREDIT_WAIT        1
831 /** lnet message is waiting for discovery */
832 #define LNET_DC_WAIT            2
833
834 struct lnet_rtrbufpool {
835         /* my free buffer pool */
836         struct list_head        rbp_bufs;
837         /* messages blocking for a buffer */
838         struct list_head        rbp_msgs;
839         /* # pages in each buffer */
840         int                     rbp_npages;
841         /* requested number of buffers */
842         int                     rbp_req_nbuffers;
843         /* # buffers actually allocated */
844         int                     rbp_nbuffers;
845         /* # free buffers / blocked messages */
846         int                     rbp_credits;
847         /* low water mark */
848         int                     rbp_mincredits;
849 };
850
851 struct lnet_rtrbuf {
852         struct list_head         rb_list;       /* chain on rbp_bufs */
853         struct lnet_rtrbufpool  *rb_pool;       /* owning pool */
854         struct bio_vec           rb_kiov[0];    /* the buffer space */
855 };
856
857 #define LNET_PEER_HASHSIZE   503                /* prime! */
858
859 enum lnet_match_flags {
860         /* Didn't match anything */
861         LNET_MATCHMD_NONE       = BIT(0),
862         /* Matched OK */
863         LNET_MATCHMD_OK         = BIT(1),
864         /* Must be discarded */
865         LNET_MATCHMD_DROP       = BIT(2),
866         /* match and buffer is exhausted */
867         LNET_MATCHMD_EXHAUSTED  = BIT(3),
868         /* match or drop */
869         LNET_MATCHMD_FINISH     = (LNET_MATCHMD_OK | LNET_MATCHMD_DROP),
870 };
871
872 /* Options for struct lnet_portal::ptl_options */
873 #define LNET_PTL_LAZY           BIT(0)
874 #define LNET_PTL_MATCH_UNIQUE   BIT(1)  /* unique match, for RDMA */
875 #define LNET_PTL_MATCH_WILDCARD BIT(2)  /* wildcard match, request portal */
876
877 /* parameter for matching operations (GET, PUT) */
878 struct lnet_match_info {
879         __u64                   mi_mbits;
880         struct lnet_process_id  mi_id;
881         unsigned int            mi_cpt;
882         unsigned int            mi_opc;
883         unsigned int            mi_portal;
884         unsigned int            mi_rlength;
885         unsigned int            mi_roffset;
886 };
887
888 /* ME hash of RDMA portal */
889 #define LNET_MT_HASH_BITS               8
890 #define LNET_MT_HASH_SIZE               (1 << LNET_MT_HASH_BITS)
891 #define LNET_MT_HASH_MASK               (LNET_MT_HASH_SIZE - 1)
892 /* we allocate (LNET_MT_HASH_SIZE + 1) entries for lnet_match_table::mt_hash,
893  * the last entry is reserved for MEs with ignore-bits */
894 #define LNET_MT_HASH_IGNORE             LNET_MT_HASH_SIZE
895 /* __u64 has 2^6 bits, so need 2^(LNET_MT_HASH_BITS - LNET_MT_BITS_U64) which
896  * is 4 __u64s as bit-map, and add an extra __u64 (only use one bit) for the
897  * ME-list with ignore-bits, which is mtable::mt_hash[LNET_MT_HASH_IGNORE] */
898 #define LNET_MT_BITS_U64                6       /* 2^6 bits */
899 #define LNET_MT_EXHAUSTED_BITS          (LNET_MT_HASH_BITS - LNET_MT_BITS_U64)
900 #define LNET_MT_EXHAUSTED_BMAP          ((1 << LNET_MT_EXHAUSTED_BITS) + 1)
901
902 /* portal match table */
903 struct lnet_match_table {
904         /* reserved for upcoming patches, CPU partition ID */
905         unsigned int            mt_cpt;
906         unsigned int            mt_portal;      /* portal index */
907         /* match table is set as "enabled" if there's non-exhausted MD
908          * attached on mt_mhash, it's only valid for wildcard portal */
909         unsigned int            mt_enabled;
910         /* bitmap to flag whether MEs on mt_hash are exhausted or not */
911         __u64                   mt_exhausted[LNET_MT_EXHAUSTED_BMAP];
912         struct list_head        *mt_mhash;      /* matching hash */
913 };
914
915 /* these are only useful for wildcard portal */
916 /* Turn off message rotor for wildcard portals */
917 #define LNET_PTL_ROTOR_OFF      0
918 /* round-robin dispatch all PUT messages for wildcard portals */
919 #define LNET_PTL_ROTOR_ON       1
920 /* round-robin dispatch routed PUT message for wildcard portals */
921 #define LNET_PTL_ROTOR_RR_RT    2
922 /* dispatch routed PUT message by hashing source NID for wildcard portals */
923 #define LNET_PTL_ROTOR_HASH_RT  3
924
925 struct lnet_portal {
926         spinlock_t              ptl_lock;
927         unsigned int            ptl_index;      /* portal ID, reserved */
928         /* flags on this portal: lazy, unique... */
929         unsigned int            ptl_options;
930         /* list of messages which are stealing buffer */
931         struct list_head        ptl_msg_stealing;
932         /* messages blocking for MD */
933         struct list_head        ptl_msg_delayed;
934         /* Match table for each CPT */
935         struct lnet_match_table **ptl_mtables;
936         /* spread rotor of incoming "PUT" */
937         unsigned int            ptl_rotor;
938         /* # active entries for this portal */
939         int                     ptl_mt_nmaps;
940         /* array of active entries' cpu-partition-id */
941         int                     ptl_mt_maps[0];
942 };
943
944 #define LNET_LH_HASH_BITS       12
945 #define LNET_LH_HASH_SIZE       (1ULL << LNET_LH_HASH_BITS)
946 #define LNET_LH_HASH_MASK       (LNET_LH_HASH_SIZE - 1)
947
948 /* resource container (ME, MD, EQ) */
949 struct lnet_res_container {
950         unsigned int            rec_type;       /* container type */
951         __u64                   rec_lh_cookie;  /* cookie generator */
952         struct list_head        rec_active;     /* active resource list */
953         struct list_head        *rec_lh_hash;   /* handle hash */
954 };
955
956 /* message container */
957 struct lnet_msg_container {
958         int                     msc_init;       /* initialized or not */
959         /* max # threads finalizing */
960         int                     msc_nfinalizers;
961         /* msgs waiting to complete finalizing */
962         struct list_head        msc_finalizing;
963         /* msgs waiting to be resent */
964         struct list_head        msc_resending;
965         struct list_head        msc_active;     /* active message list */
966         /* threads doing finalization */
967         void                    **msc_finalizers;
968         /* threads doing resends */
969         void                    **msc_resenders;
970 };
971
972 /* Peer Discovery states */
973 #define LNET_DC_STATE_SHUTDOWN          0       /* not started */
974 #define LNET_DC_STATE_RUNNING           1       /* started up OK */
975 #define LNET_DC_STATE_STOPPING          2       /* telling thread to stop */
976
977 /* Router Checker states */
978 #define LNET_MT_STATE_SHUTDOWN          0       /* not started */
979 #define LNET_MT_STATE_RUNNING           1       /* started up OK */
980 #define LNET_MT_STATE_STOPPING          2       /* telling thread to stop */
981
982 /* LNet states */
983 #define LNET_STATE_SHUTDOWN             0       /* not started */
984 #define LNET_STATE_RUNNING              1       /* started up OK */
985 #define LNET_STATE_STOPPING             2       /* telling thread to stop */
986
987 struct lnet {
988         /* CPU partition table of LNet */
989         struct cfs_cpt_table            *ln_cpt_table;
990         /* number of CPTs in ln_cpt_table */
991         unsigned int                    ln_cpt_number;
992         unsigned int                    ln_cpt_bits;
993
994         /* protect LNet resources (ME/MD/EQ) */
995         struct cfs_percpt_lock          *ln_res_lock;
996         /* # portals */
997         int                             ln_nportals;
998         /* the vector of portals */
999         struct lnet_portal              **ln_portals;
1000         /* percpt MD container */
1001         struct lnet_res_container       **ln_md_containers;
1002
1003         /* Event Queue container */
1004         struct lnet_res_container       ln_eq_container;
1005         spinlock_t                      ln_eq_wait_lock;
1006
1007         unsigned int                    ln_remote_nets_hbits;
1008
1009         /* protect NI, peer table, credits, routers, rtrbuf... */
1010         struct cfs_percpt_lock          *ln_net_lock;
1011         /* percpt message containers for active/finalizing/freed message */
1012         struct lnet_msg_container       **ln_msg_containers;
1013         struct lnet_counters            **ln_counters;
1014         struct lnet_peer_table          **ln_peer_tables;
1015         /* list of peer nis not on a local network */
1016         struct list_head                ln_remote_peer_ni_list;
1017         /* failure simulation */
1018         struct list_head                ln_test_peers;
1019         struct list_head                ln_drop_rules;
1020         struct list_head                ln_delay_rules;
1021         /* LND instances */
1022         struct list_head                ln_nets;
1023         /* the loopback NI */
1024         struct lnet_ni                  *ln_loni;
1025         /* network zombie list */
1026         struct list_head                ln_net_zombie;
1027         /* resend messages list */
1028         struct list_head                ln_msg_resend;
1029         /* spin lock to protect the msg resend list */
1030         spinlock_t                      ln_msg_resend_lock;
1031
1032         /* remote networks with routes to them */
1033         struct list_head                *ln_remote_nets_hash;
1034         /* validity stamp */
1035         __u64                           ln_remote_nets_version;
1036         /* list of all known routers */
1037         struct list_head                ln_routers;
1038         /* validity stamp */
1039         __u64                           ln_routers_version;
1040         /* percpt router buffer pools */
1041         struct lnet_rtrbufpool          **ln_rtrpools;
1042
1043         /*
1044          * Ping target / Push source
1045          *
1046          * The ping target and push source share a single buffer. The
1047          * ln_ping_target is protected against concurrent updates by
1048          * ln_api_mutex.
1049          */
1050         struct lnet_handle_md           ln_ping_target_md;
1051         lnet_handler_t                  ln_ping_target_handler;
1052         struct lnet_ping_buffer         *ln_ping_target;
1053         atomic_t                        ln_ping_target_seqno;
1054
1055         /*
1056          * Push Target
1057          *
1058          * ln_push_nnis contains the desired size of the push target.
1059          * The lnet_net_lock is used to handle update races. The old
1060          * buffer may linger a while after it has been unlinked, in
1061          * which case the event handler cleans up.
1062          */
1063         lnet_handler_t                  ln_push_target_handler;
1064         struct lnet_handle_md           ln_push_target_md;
1065         struct lnet_ping_buffer         *ln_push_target;
1066         int                             ln_push_target_nnis;
1067
1068         /* discovery event queue handle */
1069         lnet_handler_t                  ln_dc_handler;
1070         /* discovery requests */
1071         struct list_head                ln_dc_request;
1072         /* discovery working list */
1073         struct list_head                ln_dc_working;
1074         /* discovery expired list */
1075         struct list_head                ln_dc_expired;
1076         /* discovery thread wait queue */
1077         wait_queue_head_t               ln_dc_waitq;
1078         /* discovery startup/shutdown state */
1079         int                             ln_dc_state;
1080
1081         /* monitor thread startup/shutdown state */
1082         int                             ln_mt_state;
1083         /* serialise startup/shutdown */
1084         struct semaphore                ln_mt_signal;
1085
1086         struct mutex                    ln_api_mutex;
1087         struct mutex                    ln_lnd_mutex;
1088         /* Have I called LNetNIInit myself? */
1089         int                             ln_niinit_self;
1090         /* LNetNIInit/LNetNIFini counter */
1091         int                             ln_refcount;
1092         /* SHUTDOWN/RUNNING/STOPPING */
1093         int                             ln_state;
1094
1095         int                             ln_routing;     /* am I a router? */
1096         lnet_pid_t                      ln_pid;         /* requested pid */
1097         /* uniquely identifies this ni in this epoch */
1098         __u64                           ln_interface_cookie;
1099         /* registered LNDs */
1100         const struct lnet_lnd           *ln_lnds[NUM_LNDS];
1101
1102         /* test protocol compatibility flags */
1103         unsigned long                   ln_testprotocompat;
1104
1105         /* 0 - load the NIs from the mod params
1106          * 1 - do not load the NIs from the mod params
1107          * Reverse logic to ensure that other calls to LNetNIInit
1108          * need no change
1109          */
1110         bool                            ln_nis_from_mod_params;
1111
1112         /*
1113          * completion for the monitor thread. The monitor thread takes care of
1114          * checking routes, timedout messages and resending messages.
1115          */
1116         struct completion               ln_mt_wait_complete;
1117
1118         /* per-cpt resend queues */
1119         struct list_head                **ln_mt_resendqs;
1120         /* local NIs to recover */
1121         struct list_head                ln_mt_localNIRecovq;
1122         /* local NIs to recover */
1123         struct list_head                ln_mt_peerNIRecovq;
1124         /*
1125          * An array of queues for GET/PUT waiting for REPLY/ACK respectively.
1126          * There are CPT number of queues. Since response trackers will be
1127          * added on the fast path we can't afford to grab the exclusive
1128          * net lock to protect these queues. The CPT will be calculated
1129          * based on the mdh cookie.
1130          */
1131         struct list_head                **ln_mt_rstq;
1132         /*
1133          * A response tracker becomes a zombie when the associated MD is queued
1134          * for unlink before the response tracker is detached from the MD. An
1135          * entry on a zombie list can be freed when either the remaining
1136          * operations on the MD complete or when LNet has shut down.
1137          */
1138         struct list_head                **ln_mt_zombie_rstqs;
1139         /* recovery handler */
1140         lnet_handler_t                  ln_mt_handler;
1141
1142         /*
1143          * Completed when the discovery and monitor threads can enter their
1144          * work loops
1145          */
1146         struct completion               ln_started;
1147 };
1148
1149 #endif