Whamcloud - gitweb
LU-12678 lnet: me: discard struct lnet_handle_me
[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         struct list_head        eq_list;
187         struct lnet_libhandle   eq_lh;
188         unsigned long           eq_enq_seq;
189         unsigned long           eq_deq_seq;
190         unsigned int            eq_size;
191         lnet_eq_handler_t       eq_callback;
192         struct lnet_event       *eq_events;
193         int                     **eq_refs;      /* percpt refcount for EQ */
194 };
195
196 struct lnet_me {
197         struct list_head        me_list;
198         int                     me_cpt;
199         struct lnet_process_id  me_match_id;
200         unsigned int            me_portal;
201         unsigned int            me_pos;         /* hash offset in mt_hash */
202         __u64                   me_match_bits;
203         __u64                   me_ignore_bits;
204         enum lnet_unlink        me_unlink;
205         struct lnet_libmd      *me_md;
206 };
207
208 struct lnet_libmd {
209         struct list_head         md_list;
210         struct lnet_libhandle    md_lh;
211         struct lnet_me          *md_me;
212         char                    *md_start;
213         unsigned int             md_offset;
214         unsigned int             md_length;
215         unsigned int             md_max_size;
216         int                      md_threshold;
217         int                      md_refcount;
218         unsigned int             md_options;
219         unsigned int             md_flags;
220         unsigned int             md_niov;       /* # frags at end of struct */
221         void                    *md_user_ptr;
222         struct lnet_rsp_tracker *md_rspt_ptr;
223         struct lnet_eq          *md_eq;
224         struct lnet_handle_md    md_bulk_handle;
225         union {
226                 struct kvec      iov[LNET_MAX_IOV];
227                 lnet_kiov_t      kiov[LNET_MAX_IOV];
228         } md_iov;
229 };
230
231 #define LNET_MD_FLAG_ZOMBIE      (1 << 0)
232 #define LNET_MD_FLAG_AUTO_UNLINK (1 << 1)
233 #define LNET_MD_FLAG_ABORTED     (1 << 2)
234
235 struct lnet_test_peer {
236         /* info about peers we are trying to fail */
237         struct list_head        tp_list;        /* ln_test_peers */
238         lnet_nid_t              tp_nid;         /* matching nid */
239         unsigned int            tp_threshold;   /* # failures to simulate */
240 };
241
242 #define LNET_COOKIE_TYPE_MD    1
243 #define LNET_COOKIE_TYPE_ME    2
244 #define LNET_COOKIE_TYPE_EQ    3
245 #define LNET_COOKIE_TYPE_BITS  2
246 #define LNET_COOKIE_MASK        ((1ULL << LNET_COOKIE_TYPE_BITS) - 1ULL)
247
248 struct lnet_ni;                                  /* forward ref */
249 struct socket;
250
251 struct lnet_lnd {
252         /* fields initialized by the LND */
253         __u32                   lnd_type;
254
255         int  (*lnd_startup)(struct lnet_ni *ni);
256         void (*lnd_shutdown)(struct lnet_ni *ni);
257         int  (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
258
259         /* In data movement APIs below, payload buffers are described as a set
260          * of 'niov' fragments which are...
261          * EITHER
262          *    in virtual memory (struct kvec *iov != NULL)
263          * OR
264          *    in pages (kernel only: plt_kiov_t *kiov != NULL).
265          * The LND may NOT overwrite these fragment descriptors.
266          * An 'offset' and may specify a byte offset within the set of
267          * fragments to start from
268          */
269
270         /* Start sending a preformatted message.  'private' is NULL for PUT and
271          * GET messages; otherwise this is a response to an incoming message
272          * and 'private' is the 'private' passed to lnet_parse().  Return
273          * non-zero for immediate failure, otherwise complete later with
274          * lnet_finalize() */
275         int (*lnd_send)(struct lnet_ni *ni, void *private,
276                         struct lnet_msg *msg);
277
278         /* Start receiving 'mlen' bytes of payload data, skipping the following
279          * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
280          * lnet_parse().  Return non-zero for immedaite failure, otherwise
281          * complete later with lnet_finalize().  This also gives back a receive
282          * credit if the LND does flow control. */
283         int (*lnd_recv)(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
284                         int delayed, unsigned int niov,
285                         struct kvec *iov, lnet_kiov_t *kiov,
286                         unsigned int offset, unsigned int mlen, unsigned int rlen);
287
288         /* lnet_parse() has had to delay processing of this message
289          * (e.g. waiting for a forwarding buffer or send credits).  Give the
290          * LND a chance to free urgently needed resources.  If called, return 0
291          * for success and do NOT give back a receive credit; that has to wait
292          * until lnd_recv() gets called.  On failure return < 0 and
293          * release resources; lnd_recv() will not be called. */
294         int (*lnd_eager_recv)(struct lnet_ni *ni, void *private,
295                               struct lnet_msg *msg, void **new_privatep);
296
297         /* notification of peer down */
298         void (*lnd_notify_peer_down)(lnet_nid_t peer);
299
300         /* query of peer aliveness */
301         void (*lnd_query)(struct lnet_ni *ni, lnet_nid_t peer, time64_t *when);
302
303         /* accept a new connection */
304         int (*lnd_accept)(struct lnet_ni *ni, struct socket *sock);
305 };
306
307 struct lnet_tx_queue {
308         int                     tq_credits;     /* # tx credits free */
309         int                     tq_credits_min; /* lowest it's been */
310         int                     tq_credits_max; /* total # tx credits */
311         struct list_head        tq_delayed;     /* delayed TXs */
312 };
313
314 enum lnet_net_state {
315         /* set when net block is allocated */
316         LNET_NET_STATE_INIT = 0,
317         /* set when NIs in net are started successfully */
318         LNET_NET_STATE_ACTIVE,
319         /* set if all NIs in net are in FAILED state */
320         LNET_NET_STATE_INACTIVE,
321         /* set when shutting down a NET */
322         LNET_NET_STATE_DELETING
323 };
324
325 enum lnet_ni_state {
326         /* initial state when NI is created */
327         LNET_NI_STATE_INIT = 0,
328         /* set when NI is brought up */
329         LNET_NI_STATE_ACTIVE,
330         /* set when NI is being shutdown */
331         LNET_NI_STATE_DELETING,
332 };
333
334 #define LNET_NI_RECOVERY_PENDING        BIT(0)
335 #define LNET_NI_RECOVERY_FAILED         BIT(1)
336
337 enum lnet_stats_type {
338         LNET_STATS_TYPE_SEND = 0,
339         LNET_STATS_TYPE_RECV,
340         LNET_STATS_TYPE_DROP
341 };
342
343 struct lnet_comm_count {
344         atomic_t co_get_count;
345         atomic_t co_put_count;
346         atomic_t co_reply_count;
347         atomic_t co_ack_count;
348         atomic_t co_hello_count;
349 };
350
351 struct lnet_element_stats {
352         struct lnet_comm_count el_send_stats;
353         struct lnet_comm_count el_recv_stats;
354         struct lnet_comm_count el_drop_stats;
355 };
356
357 struct lnet_health_local_stats {
358         atomic_t hlt_local_interrupt;
359         atomic_t hlt_local_dropped;
360         atomic_t hlt_local_aborted;
361         atomic_t hlt_local_no_route;
362         atomic_t hlt_local_timeout;
363         atomic_t hlt_local_error;
364 };
365
366 struct lnet_health_remote_stats {
367         atomic_t hlt_remote_dropped;
368         atomic_t hlt_remote_timeout;
369         atomic_t hlt_remote_error;
370         atomic_t hlt_network_timeout;
371 };
372
373 struct lnet_net {
374         /* chain on the ln_nets */
375         struct list_head        net_list;
376
377         /* net ID, which is composed of
378          * (net_type << 16) | net_num.
379          * net_type can be one of the enumerated types defined in
380          * lnet/include/lnet/nidstr.h */
381         __u32                   net_id;
382
383         /* priority of the network */
384         __u32                   net_prio;
385
386         /* total number of CPTs in the array */
387         __u32                   net_ncpts;
388
389         /* cumulative CPTs of all NIs in this net */
390         __u32                   *net_cpts;
391
392         /* network tunables */
393         struct lnet_ioctl_config_lnd_cmn_tunables net_tunables;
394
395         /*
396          * boolean to indicate that the tunables have been set and
397          * shouldn't be reset
398          */
399         bool                    net_tunables_set;
400
401         /* procedural interface */
402         const struct lnet_lnd   *net_lnd;
403
404         /* list of NIs on this net */
405         struct list_head        net_ni_list;
406
407         /* list of NIs being added, but not started yet */
408         struct list_head        net_ni_added;
409
410         /* dying LND instances */
411         struct list_head        net_ni_zombie;
412
413         /* when I was last alive */
414         time64_t                net_last_alive;
415
416         /* protects access to net_last_alive */
417         spinlock_t              net_lock;
418 };
419
420 struct lnet_ni {
421         /* chain on the lnet_net structure */
422         struct list_head        ni_netlist;
423
424         /* chain on the recovery queue */
425         struct list_head        ni_recovery;
426
427         /* MD handle for recovery ping */
428         struct lnet_handle_md   ni_ping_mdh;
429
430         spinlock_t              ni_lock;
431
432         /* number of CPTs */
433         int                     ni_ncpts;
434
435         /* bond NI on some CPTs */
436         __u32                   *ni_cpts;
437
438         /* interface's NID */
439         lnet_nid_t              ni_nid;
440
441         /* instance-specific data */
442         void                    *ni_data;
443
444         /* per ni credits */
445         atomic_t                ni_tx_credits;
446
447         /* percpt TX queues */
448         struct lnet_tx_queue    **ni_tx_queues;
449
450         /* percpt reference count */
451         int                     **ni_refs;
452
453         /* pointer to parent network */
454         struct lnet_net         *ni_net;
455
456         /* my health status */
457         struct lnet_ni_status   *ni_status;
458
459         /* NI FSM. Protected by lnet_ni_lock() */
460         enum lnet_ni_state      ni_state;
461
462         /* Recovery state. Protected by lnet_ni_lock() */
463         __u32                   ni_recovery_state;
464
465         /* per NI LND tunables */
466         struct lnet_lnd_tunables ni_lnd_tunables;
467
468         /* lnd tunables set explicitly */
469         bool ni_lnd_tunables_set;
470
471         /* NI statistics */
472         struct lnet_element_stats ni_stats;
473         struct lnet_health_local_stats ni_hstats;
474
475         /* physical device CPT */
476         int                     ni_dev_cpt;
477
478         /* sequence number used to round robin over nis within a net */
479         __u32                   ni_seq;
480
481         /*
482          * health value
483          *      initialized to LNET_MAX_HEALTH_VALUE
484          * Value is decremented every time we fail to send a message over
485          * this NI because of a NI specific failure.
486          * Value is incremented if we successfully send a message.
487          */
488         atomic_t                ni_healthv;
489
490         /*
491          * Set to 1 by the LND when it receives an event telling it the device
492          * has gone into a fatal state. Set to 0 when the LND receives an
493          * even telling it the device is back online.
494          */
495         atomic_t                ni_fatal_error_on;
496
497         /*
498          * equivalent interfaces to use
499          * This is an array because socklnd bonding can still be configured
500          */
501         char                    *ni_interfaces[LNET_INTERFACES_NUM];
502         struct net              *ni_net_ns;     /* original net namespace */
503 };
504
505 #define LNET_PROTO_PING_MATCHBITS       0x8000000000000000LL
506
507 /*
508  * Descriptor of a ping info buffer: keep a separate indicator of the
509  * size and a reference count. The type is used both as a source and
510  * sink of data, so we need to keep some information outside of the
511  * area that may be overwritten by network data.
512  */
513 struct lnet_ping_buffer {
514         int                     pb_nnis;
515         atomic_t                pb_refcnt;
516         struct lnet_ping_info   pb_info;
517 };
518
519 #define LNET_PING_BUFFER_SIZE(NNIDS) \
520         offsetof(struct lnet_ping_buffer, pb_info.pi_ni[NNIDS])
521 #define LNET_PING_BUFFER_LONI(PBUF)     ((PBUF)->pb_info.pi_ni[0].ns_nid)
522 #define LNET_PING_BUFFER_SEQNO(PBUF)    ((PBUF)->pb_info.pi_ni[0].ns_status)
523
524 #define LNET_PING_INFO_TO_BUFFER(PINFO) \
525         container_of((PINFO), struct lnet_ping_buffer, pb_info)
526
527 struct lnet_peer_ni {
528         /* chain on lpn_peer_nis */
529         struct list_head        lpni_peer_nis;
530         /* chain on remote peer list */
531         struct list_head        lpni_on_remote_peer_ni_list;
532         /* chain on recovery queue */
533         struct list_head        lpni_recovery;
534         /* chain on peer hash */
535         struct list_head        lpni_hashlist;
536         /* messages blocking for tx credits */
537         struct list_head        lpni_txq;
538         /* pointer to peer net I'm part of */
539         struct lnet_peer_net    *lpni_peer_net;
540         /* statistics kept on each peer NI */
541         struct lnet_element_stats lpni_stats;
542         struct lnet_health_remote_stats lpni_hstats;
543         /* spin lock protecting credits and lpni_txq */
544         spinlock_t              lpni_lock;
545         /* # tx credits available */
546         int                     lpni_txcredits;
547         /* low water mark */
548         int                     lpni_mintxcredits;
549         /*
550          * Each peer_ni in a gateway maintains its own credits. This
551          * allows more traffic to gateways that have multiple interfaces.
552          */
553         /* # router credits */
554         int                     lpni_rtrcredits;
555         /* low water mark */
556         int                     lpni_minrtrcredits;
557         /* bytes queued for sending */
558         long                    lpni_txqnob;
559         /* network peer is on */
560         struct lnet_net         *lpni_net;
561         /* peer's NID */
562         lnet_nid_t              lpni_nid;
563         /* # refs */
564         atomic_t                lpni_refcount;
565         /* health value for the peer */
566         atomic_t                lpni_healthv;
567         /* recovery ping mdh */
568         struct lnet_handle_md   lpni_recovery_ping_mdh;
569         /* CPT this peer attached on */
570         int                     lpni_cpt;
571         /* state flags -- protected by lpni_lock */
572         unsigned                lpni_state;
573         /* status of the peer NI as reported by the peer */
574         __u32                   lpni_ns_status;
575         /* sequence number used to round robin over peer nis within a net */
576         __u32                   lpni_seq;
577         /* sequence number used to round robin over gateways */
578         __u32                   lpni_gw_seq;
579         /* returned RC ping features. Protected with lpni_lock */
580         unsigned int            lpni_ping_feats;
581         /* time last message was received from the peer */
582         time64_t                lpni_last_alive;
583         /* preferred local nids: if only one, use lpni_pref.nid */
584         union lpni_pref {
585                 lnet_nid_t      nid;
586                 lnet_nid_t      *nids;
587         } lpni_pref;
588         /* number of preferred NIDs in lnpi_pref_nids */
589         __u32                   lpni_pref_nnids;
590 };
591
592 /* Preferred path added due to traffic on non-MR peer_ni */
593 #define LNET_PEER_NI_NON_MR_PREF        (1 << 0)
594 /* peer is being recovered. */
595 #define LNET_PEER_NI_RECOVERY_PENDING   (1 << 1)
596 /* recovery ping failed */
597 #define LNET_PEER_NI_RECOVERY_FAILED    (1 << 2)
598 /* peer is being deleted */
599 #define LNET_PEER_NI_DELETING           (1 << 3)
600
601 struct lnet_peer {
602         /* chain on pt_peer_list */
603         struct list_head        lp_peer_list;
604
605         /* list of peer nets */
606         struct list_head        lp_peer_nets;
607
608         /* list of messages pending discovery*/
609         struct list_head        lp_dc_pendq;
610
611         /* chain on router list */
612         struct list_head        lp_rtr_list;
613
614         /* primary NID of the peer */
615         lnet_nid_t              lp_primary_nid;
616
617         /* net to perform discovery on */
618         __u32                   lp_disc_net_id;
619
620         /* CPT of peer_table */
621         int                     lp_cpt;
622
623         /* number of NIDs on this peer */
624         int                     lp_nnis;
625
626         /* # refs from lnet_route::lr_gateway */
627         int                     lp_rtr_refcount;
628
629         /*
630          * peer specific health sensitivity value to decrement peer nis in
631          * this peer with if set to something other than 0
632          */
633         __u32                   lp_health_sensitivity;
634
635         /* messages blocking for router credits */
636         struct list_head        lp_rtrq;
637
638         /* routes on this peer */
639         struct list_head        lp_routes;
640
641         /* reference count */
642         atomic_t                lp_refcount;
643
644         /* lock protecting peer state flags and lpni_rtrq */
645         spinlock_t              lp_lock;
646
647         /* peer state flags */
648         unsigned                lp_state;
649
650         /* buffer for data pushed by peer */
651         struct lnet_ping_buffer *lp_data;
652
653         /* MD handle for ping in progress */
654         struct lnet_handle_md   lp_ping_mdh;
655
656         /* MD handle for push in progress */
657         struct lnet_handle_md   lp_push_mdh;
658
659         /* number of NIDs for sizing push data */
660         int                     lp_data_nnis;
661
662         /* NI config sequence number of peer */
663         __u32                   lp_peer_seqno;
664
665         /* Local NI config sequence number acked by peer */
666         __u32                   lp_node_seqno;
667
668         /* Local NI config sequence number sent to peer */
669         __u32                   lp_node_seqno_sent;
670
671         /* Ping error encountered during discovery. */
672         int                     lp_ping_error;
673
674         /* Push error encountered during discovery. */
675         int                     lp_push_error;
676
677         /* Error encountered during discovery. */
678         int                     lp_dc_error;
679
680         /* time it was put on the ln_dc_working queue */
681         time64_t                lp_last_queued;
682
683         /* link on discovery-related lists */
684         struct list_head        lp_dc_list;
685
686         /* tasks waiting on discovery of this peer */
687         wait_queue_head_t       lp_dc_waitq;
688
689         /* cached peer aliveness */
690         bool                    lp_alive;
691 };
692
693 /*
694  * The status flags in lp_state. Their semantics have chosen so that
695  * lp_state can be zero-initialized.
696  *
697  * A peer is marked MULTI_RAIL in two cases: it was configured using DLC
698  * as multi-rail aware, or the LNET_PING_FEAT_MULTI_RAIL bit was set.
699  *
700  * A peer is marked NO_DISCOVERY if the LNET_PING_FEAT_DISCOVERY bit was
701  * NOT set when the peer was pinged by discovery.
702  *
703  * A peer is marked ROUTER if it indicates so in the feature bit.
704  */
705 #define LNET_PEER_MULTI_RAIL    (1 << 0)        /* Multi-rail aware */
706 #define LNET_PEER_NO_DISCOVERY  (1 << 1)        /* Peer disabled discovery */
707 #define LNET_PEER_ROUTER_ENABLED (1 << 2)       /* router feature enabled */
708
709 /*
710  * A peer is marked CONFIGURED if it was configured by DLC.
711  *
712  * In addition, a peer is marked DISCOVERED if it has fully passed
713  * through Peer Discovery.
714  *
715  * When Peer Discovery is disabled, the discovery thread will mark
716  * peers REDISCOVER to indicate that they should be re-examined if
717  * discovery is (re)enabled on the node.
718  *
719  * A peer that was created as the result of inbound traffic will not
720  * be marked at all.
721  */
722 #define LNET_PEER_CONFIGURED    (1 << 3)        /* Configured via DLC */
723 #define LNET_PEER_DISCOVERED    (1 << 4)        /* Peer was discovered */
724 #define LNET_PEER_REDISCOVER    (1 << 5)        /* Discovery was disabled */
725 /*
726  * A peer is marked DISCOVERING when discovery is in progress.
727  * The other flags below correspond to stages of discovery.
728  */
729 #define LNET_PEER_DISCOVERING   (1 << 6)        /* Discovering */
730 #define LNET_PEER_DATA_PRESENT  (1 << 7)        /* Remote peer data present */
731 #define LNET_PEER_NIDS_UPTODATE (1 << 8)        /* Remote peer info uptodate */
732 #define LNET_PEER_PING_SENT     (1 << 9)        /* Waiting for REPLY to Ping */
733 #define LNET_PEER_PUSH_SENT     (1 << 10)       /* Waiting for ACK of Push */
734 #define LNET_PEER_PING_FAILED   (1 << 11)       /* Ping send failure */
735 #define LNET_PEER_PUSH_FAILED   (1 << 12)       /* Push send failure */
736 /*
737  * A ping can be forced as a way to fix up state, or as a manual
738  * intervention by an admin.
739  * A push can be forced in circumstances that would normally not
740  * allow for one to happen.
741  */
742 #define LNET_PEER_FORCE_PING    (1 << 13)       /* Forced Ping */
743 #define LNET_PEER_FORCE_PUSH    (1 << 14)       /* Forced Push */
744
745 /* force delete even if router */
746 #define LNET_PEER_RTR_NI_FORCE_DEL (1 << 15)
747
748 /* gw undergoing alive discovery */
749 #define LNET_PEER_RTR_DISCOVERY (1 << 16)
750 /* gw has undergone discovery (does not indicate success or failure) */
751 #define LNET_PEER_RTR_DISCOVERED (1 << 17)
752
753 struct lnet_peer_net {
754         /* chain on lp_peer_nets */
755         struct list_head        lpn_peer_nets;
756
757         /* list of peer_nis on this network */
758         struct list_head        lpn_peer_nis;
759
760         /* pointer to the peer I'm part of */
761         struct lnet_peer        *lpn_peer;
762
763         /* Net ID */
764         __u32                   lpn_net_id;
765
766         /* time of last router net check attempt */
767         time64_t                lpn_rtrcheck_timestamp;
768
769         /* selection sequence number */
770         __u32                   lpn_seq;
771
772         /* reference count */
773         atomic_t                lpn_refcount;
774 };
775
776 /* peer hash size */
777 #define LNET_PEER_HASH_BITS     9
778 #define LNET_PEER_HASH_SIZE     (1 << LNET_PEER_HASH_BITS)
779
780 /*
781  * peer hash table - one per CPT
782  *
783  * protected by lnet_net_lock/EX for update
784  *    pt_version
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         struct list_head        *pt_hash;       /* NID->peer hash */
797         struct list_head        pt_peer_list;   /* peers */
798         int                     pt_peers;       /* # peers */
799         struct list_head        pt_zombie_list; /* zombie peer_ni */
800         int                     pt_zombies;     /* # zombie peers_ni */
801         spinlock_t              pt_zombie_lock; /* protect list and count */
802 };
803
804 /* peer aliveness is enabled only on routers for peers in a network where the
805  * struct lnet_ni::ni_peertimeout has been set to a positive value
806  */
807 #define lnet_peer_aliveness_enabled(lp) (the_lnet.ln_routing != 0 && \
808                                         ((lp)->lpni_net) && \
809                                         (lp)->lpni_net->net_tunables.lct_peer_timeout > 0)
810
811 struct lnet_route {
812         struct list_head        lr_list;        /* chain on net */
813         struct list_head        lr_gwlist;      /* chain on gateway */
814         struct lnet_peer        *lr_gateway;    /* router node */
815         lnet_nid_t              lr_nid;         /* NID used to add route */
816         __u32                   lr_net;         /* remote network number */
817         __u32                   lr_lnet;        /* local network number */
818         int                     lr_seq;         /* sequence for round-robin */
819         __u32                   lr_hops;        /* how far I am */
820         unsigned int            lr_priority;    /* route priority */
821         bool                    lr_alive;       /* cached route aliveness */
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         /* msgs waiting to be resent */
974         struct list_head        msc_resending;
975         struct list_head        msc_active;     /* active message list */
976         /* threads doing finalization */
977         void                    **msc_finalizers;
978         /* threads doing resends */
979         void                    **msc_resenders;
980 };
981
982 /* Peer Discovery states */
983 #define LNET_DC_STATE_SHUTDOWN          0       /* not started */
984 #define LNET_DC_STATE_RUNNING           1       /* started up OK */
985 #define LNET_DC_STATE_STOPPING          2       /* telling thread to stop */
986
987 /* Router Checker states */
988 #define LNET_MT_STATE_SHUTDOWN          0       /* not started */
989 #define LNET_MT_STATE_RUNNING           1       /* started up OK */
990 #define LNET_MT_STATE_STOPPING          2       /* telling thread to stop */
991
992 /* LNet states */
993 #define LNET_STATE_SHUTDOWN             0       /* not started */
994 #define LNET_STATE_RUNNING              1       /* started up OK */
995 #define LNET_STATE_STOPPING             2       /* telling thread to stop */
996
997 struct lnet {
998         /* CPU partition table of LNet */
999         struct cfs_cpt_table            *ln_cpt_table;
1000         /* number of CPTs in ln_cpt_table */
1001         unsigned int                    ln_cpt_number;
1002         unsigned int                    ln_cpt_bits;
1003
1004         /* protect LNet resources (ME/MD/EQ) */
1005         struct cfs_percpt_lock          *ln_res_lock;
1006         /* # portals */
1007         int                             ln_nportals;
1008         /* the vector of portals */
1009         struct lnet_portal              **ln_portals;
1010         /* percpt MD container */
1011         struct lnet_res_container       **ln_md_containers;
1012
1013         /* Event Queue container */
1014         struct lnet_res_container       ln_eq_container;
1015         wait_queue_head_t               ln_eq_waitq;
1016         spinlock_t                      ln_eq_wait_lock;
1017
1018         unsigned int                    ln_remote_nets_hbits;
1019
1020         /* protect NI, peer table, credits, routers, rtrbuf... */
1021         struct cfs_percpt_lock          *ln_net_lock;
1022         /* percpt message containers for active/finalizing/freed message */
1023         struct lnet_msg_container       **ln_msg_containers;
1024         struct lnet_counters            **ln_counters;
1025         struct lnet_peer_table          **ln_peer_tables;
1026         /* list of peer nis not on a local network */
1027         struct list_head                ln_remote_peer_ni_list;
1028         /* failure simulation */
1029         struct list_head                ln_test_peers;
1030         struct list_head                ln_drop_rules;
1031         struct list_head                ln_delay_rules;
1032         /* LND instances */
1033         struct list_head                ln_nets;
1034         /* the loopback NI */
1035         struct lnet_ni                  *ln_loni;
1036         /* network zombie list */
1037         struct list_head                ln_net_zombie;
1038         /* resend messages list */
1039         struct list_head                ln_msg_resend;
1040         /* spin lock to protect the msg resend list */
1041         spinlock_t                      ln_msg_resend_lock;
1042
1043         /* remote networks with routes to them */
1044         struct list_head                *ln_remote_nets_hash;
1045         /* validity stamp */
1046         __u64                           ln_remote_nets_version;
1047         /* list of all known routers */
1048         struct list_head                ln_routers;
1049         /* validity stamp */
1050         __u64                           ln_routers_version;
1051         /* percpt router buffer pools */
1052         struct lnet_rtrbufpool          **ln_rtrpools;
1053
1054         /*
1055          * Ping target / Push source
1056          *
1057          * The ping target and push source share a single buffer. The
1058          * ln_ping_target is protected against concurrent updates by
1059          * ln_api_mutex.
1060          */
1061         struct lnet_handle_md           ln_ping_target_md;
1062         struct lnet_handle_eq           ln_ping_target_eq;
1063         struct lnet_ping_buffer         *ln_ping_target;
1064         atomic_t                        ln_ping_target_seqno;
1065
1066         /*
1067          * Push Target
1068          *
1069          * ln_push_nnis contains the desired size of the push target.
1070          * The lnet_net_lock is used to handle update races. The old
1071          * buffer may linger a while after it has been unlinked, in
1072          * which case the event handler cleans up.
1073          */
1074         struct lnet_handle_eq           ln_push_target_eq;
1075         struct lnet_handle_md           ln_push_target_md;
1076         struct lnet_ping_buffer         *ln_push_target;
1077         int                             ln_push_target_nnis;
1078
1079         /* discovery event queue handle */
1080         struct lnet_handle_eq           ln_dc_eqh;
1081         /* discovery requests */
1082         struct list_head                ln_dc_request;
1083         /* discovery working list */
1084         struct list_head                ln_dc_working;
1085         /* discovery expired list */
1086         struct list_head                ln_dc_expired;
1087         /* discovery thread wait queue */
1088         wait_queue_head_t               ln_dc_waitq;
1089         /* discovery startup/shutdown state */
1090         int                             ln_dc_state;
1091
1092         /* monitor thread startup/shutdown state */
1093         int                             ln_mt_state;
1094         /* serialise startup/shutdown */
1095         struct semaphore                ln_mt_signal;
1096
1097         struct mutex                    ln_api_mutex;
1098         struct mutex                    ln_lnd_mutex;
1099         /* Have I called LNetNIInit myself? */
1100         int                             ln_niinit_self;
1101         /* LNetNIInit/LNetNIFini counter */
1102         int                             ln_refcount;
1103         /* SHUTDOWN/RUNNING/STOPPING */
1104         int                             ln_state;
1105
1106         int                             ln_routing;     /* am I a router? */
1107         lnet_pid_t                      ln_pid;         /* requested pid */
1108         /* uniquely identifies this ni in this epoch */
1109         __u64                           ln_interface_cookie;
1110         /* registered LNDs */
1111         const struct lnet_lnd           *ln_lnds[NUM_LNDS];
1112
1113         /* test protocol compatibility flags */
1114         unsigned long                   ln_testprotocompat;
1115
1116         /* 0 - load the NIs from the mod params
1117          * 1 - do not load the NIs from the mod params
1118          * Reverse logic to ensure that other calls to LNetNIInit
1119          * need no change
1120          */
1121         bool                            ln_nis_from_mod_params;
1122
1123         /*
1124          * completion for the monitor thread. The monitor thread takes care of
1125          * checking routes, timedout messages and resending messages.
1126          */
1127         struct completion               ln_mt_wait_complete;
1128
1129         /* per-cpt resend queues */
1130         struct list_head                **ln_mt_resendqs;
1131         /* local NIs to recover */
1132         struct list_head                ln_mt_localNIRecovq;
1133         /* local NIs to recover */
1134         struct list_head                ln_mt_peerNIRecovq;
1135         /*
1136          * An array of queues for GET/PUT waiting for REPLY/ACK respectively.
1137          * There are CPT number of queues. Since response trackers will be
1138          * added on the fast path we can't afford to grab the exclusive
1139          * net lock to protect these queues. The CPT will be calculated
1140          * based on the mdh cookie.
1141          */
1142         struct list_head                **ln_mt_rstq;
1143         /*
1144          * A response tracker becomes a zombie when the associated MD is queued
1145          * for unlink before the response tracker is detached from the MD. An
1146          * entry on a zombie list can be freed when either the remaining
1147          * operations on the MD complete or when LNet has shut down.
1148          */
1149         struct list_head                **ln_mt_zombie_rstqs;
1150         /* recovery eq handler */
1151         struct lnet_handle_eq           ln_mt_eqh;
1152
1153         /*
1154          * Completed when the discovery and monitor threads can enter their
1155          * work loops
1156          */
1157         struct completion               ln_started;
1158 };
1159
1160 #endif