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