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