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