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