4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lnet/include/lnet/lib-types.h
34 * Types used by the library side routines that do not need to be
35 * exposed to the user application
38 #ifndef __LNET_LIB_TYPES_H__
39 #define __LNET_LIB_TYPES_H__
42 # error This include is only for kernel use.
45 #include <linux/kthread.h>
46 #include <linux/uio.h>
47 #include <linux/semaphore.h>
48 #include <linux/types.h>
50 #include <uapi/linux/lnet/lnet-dlc.h>
51 #include <uapi/linux/lnet/lnetctl.h>
52 #include <uapi/linux/lnet/nidstr.h>
54 /* Max payload size */
55 #define LNET_MAX_PAYLOAD LNET_MTU
57 #define LNET_MAX_IOV (LNET_MAX_PAYLOAD >> PAGE_SHIFT)
60 * This is the maximum health value.
61 * All local and peer NIs created have their health default to this value.
63 #define LNET_MAX_HEALTH_VALUE 1000
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,
83 struct lnet_rsp_tracker {
84 /* chain on the waiting list */
85 struct list_head rspt_on_list;
89 lnet_nid_t rspt_next_hop_nid;
90 /* deadline of the REPLY/ACK */
91 ktime_t rspt_deadline;
93 struct lnet_handle_md rspt_mdh;
97 struct list_head msg_activelist;
98 struct list_head msg_list; /* Q for credits/MD */
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 */
108 * hold parameters in case message is with held due
111 lnet_nid_t msg_src_nid_param;
112 lnet_nid_t msg_rtr_nid_param;
115 * Deadline for the message after which it will be finalized if it
118 ktime_t msg_deadline;
120 /* The message health status. */
121 enum lnet_msg_hstatus msg_health_status;
122 /* This is a recovery message */
124 /* the number of times a transmission has been retried */
126 /* flag to indicate that we do not want to resend this message */
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;
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;
157 struct lnet_peer_ni *msg_txpeer; /* peer I'm sending to */
158 struct lnet_peer_ni *msg_rxpeer; /* peer I received from */
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;
166 unsigned int msg_len;
167 unsigned int msg_wanted;
168 unsigned int msg_offset;
169 unsigned int msg_niov;
170 struct bio_vec *msg_kiov;
172 struct lnet_event msg_ev;
173 struct lnet_hdr msg_hdr;
176 struct lnet_libhandle {
177 struct list_head lh_hash_chain;
181 #define lh_entry(ptr, type, member) \
182 ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
185 struct list_head me_list;
187 struct lnet_process_id me_match_id;
188 unsigned int me_portal;
189 unsigned int me_pos; /* hash offset in mt_hash */
191 __u64 me_ignore_bits;
192 enum lnet_unlink me_unlink;
193 struct lnet_libmd *me_md;
197 struct list_head md_list;
198 struct lnet_libhandle md_lh;
199 struct lnet_me *md_me;
201 unsigned int md_offset;
202 unsigned int md_length;
203 unsigned int md_max_size;
206 unsigned int md_options;
207 unsigned int md_flags;
208 unsigned int md_niov; /* # frags at end of struct */
210 struct lnet_rsp_tracker *md_rspt_ptr;
211 lnet_handler_t md_handler;
212 struct lnet_handle_md md_bulk_handle;
213 struct bio_vec md_kiov[LNET_MAX_IOV];
216 #define LNET_MD_FLAG_ZOMBIE (1 << 0)
217 #define LNET_MD_FLAG_AUTO_UNLINK (1 << 1)
218 #define LNET_MD_FLAG_ABORTED (1 << 2)
220 struct lnet_test_peer {
221 /* info about peers we are trying to fail */
222 struct list_head tp_list; /* ln_test_peers */
223 lnet_nid_t tp_nid; /* matching nid */
224 unsigned int tp_threshold; /* # failures to simulate */
227 #define LNET_COOKIE_TYPE_MD 1
228 #define LNET_COOKIE_TYPE_ME 2
229 #define LNET_COOKIE_TYPE_EQ 3
230 #define LNET_COOKIE_TYPE_BITS 2
231 #define LNET_COOKIE_MASK ((1ULL << LNET_COOKIE_TYPE_BITS) - 1ULL)
233 struct lnet_ni; /* forward ref */
237 /* fields initialized by the LND */
240 int (*lnd_startup)(struct lnet_ni *ni);
241 void (*lnd_shutdown)(struct lnet_ni *ni);
242 int (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
244 /* In data movement APIs below, payload buffers are described as a set
245 * of 'niov' fragments which are...
247 * in virtual memory (struct kvec *iov != NULL)
249 * in pages (kernel only: plt_kiov_t *kiov != NULL).
250 * The LND may NOT overwrite these fragment descriptors.
251 * An 'offset' and may specify a byte offset within the set of
252 * fragments to start from
255 /* Start sending a preformatted message. 'private' is NULL for PUT and
256 * GET messages; otherwise this is a response to an incoming message
257 * and 'private' is the 'private' passed to lnet_parse(). Return
258 * non-zero for immediate failure, otherwise complete later with
260 int (*lnd_send)(struct lnet_ni *ni, void *private,
261 struct lnet_msg *msg);
263 /* Start receiving 'mlen' bytes of payload data, skipping the following
264 * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
265 * lnet_parse(). Return non-zero for immedaite failure, otherwise
266 * complete later with lnet_finalize(). This also gives back a receive
267 * credit if the LND does flow control. */
268 int (*lnd_recv)(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
269 int delayed, unsigned int niov,
270 struct kvec *iov, struct bio_vec *kiov,
271 unsigned int offset, unsigned int mlen, unsigned int rlen);
273 /* lnet_parse() has had to delay processing of this message
274 * (e.g. waiting for a forwarding buffer or send credits). Give the
275 * LND a chance to free urgently needed resources. If called, return 0
276 * for success and do NOT give back a receive credit; that has to wait
277 * until lnd_recv() gets called. On failure return < 0 and
278 * release resources; lnd_recv() will not be called. */
279 int (*lnd_eager_recv)(struct lnet_ni *ni, void *private,
280 struct lnet_msg *msg, void **new_privatep);
282 /* notification of peer down */
283 void (*lnd_notify_peer_down)(lnet_nid_t peer);
285 /* accept a new connection */
286 int (*lnd_accept)(struct lnet_ni *ni, struct socket *sock);
289 struct lnet_tx_queue {
290 int tq_credits; /* # tx credits free */
291 int tq_credits_min; /* lowest it's been */
292 int tq_credits_max; /* total # tx credits */
293 struct list_head tq_delayed; /* delayed TXs */
296 enum lnet_net_state {
297 /* set when net block is allocated */
298 LNET_NET_STATE_INIT = 0,
299 /* set when NIs in net are started successfully */
300 LNET_NET_STATE_ACTIVE,
301 /* set if all NIs in net are in FAILED state */
302 LNET_NET_STATE_INACTIVE,
303 /* set when shutting down a NET */
304 LNET_NET_STATE_DELETING
308 /* initial state when NI is created */
309 LNET_NI_STATE_INIT = 0,
310 /* set when NI is brought up */
311 LNET_NI_STATE_ACTIVE,
312 /* set when NI is being shutdown */
313 LNET_NI_STATE_DELETING,
316 #define LNET_NI_RECOVERY_PENDING BIT(0)
317 #define LNET_NI_RECOVERY_FAILED BIT(1)
319 enum lnet_stats_type {
320 LNET_STATS_TYPE_SEND = 0,
321 LNET_STATS_TYPE_RECV,
325 struct lnet_comm_count {
326 atomic_t co_get_count;
327 atomic_t co_put_count;
328 atomic_t co_reply_count;
329 atomic_t co_ack_count;
330 atomic_t co_hello_count;
333 struct lnet_element_stats {
334 struct lnet_comm_count el_send_stats;
335 struct lnet_comm_count el_recv_stats;
336 struct lnet_comm_count el_drop_stats;
339 struct lnet_health_local_stats {
340 atomic_t hlt_local_interrupt;
341 atomic_t hlt_local_dropped;
342 atomic_t hlt_local_aborted;
343 atomic_t hlt_local_no_route;
344 atomic_t hlt_local_timeout;
345 atomic_t hlt_local_error;
348 struct lnet_health_remote_stats {
349 atomic_t hlt_remote_dropped;
350 atomic_t hlt_remote_timeout;
351 atomic_t hlt_remote_error;
352 atomic_t hlt_network_timeout;
356 /* chain on the ln_nets */
357 struct list_head net_list;
359 /* net ID, which is composed of
360 * (net_type << 16) | net_num.
361 * net_type can be one of the enumerated types defined in
362 * lnet/include/lnet/nidstr.h */
365 /* priority of the network */
368 /* total number of CPTs in the array */
371 /* cumulative CPTs of all NIs in this net */
374 /* network tunables */
375 struct lnet_ioctl_config_lnd_cmn_tunables net_tunables;
378 * boolean to indicate that the tunables have been set and
381 bool net_tunables_set;
383 /* procedural interface */
384 const struct lnet_lnd *net_lnd;
386 /* list of NIs on this net */
387 struct list_head net_ni_list;
389 /* list of NIs being added, but not started yet */
390 struct list_head net_ni_added;
392 /* dying LND instances */
393 struct list_head net_ni_zombie;
395 /* when I was last alive */
396 time64_t net_last_alive;
398 /* protects access to net_last_alive */
403 /* chain on the lnet_net structure */
404 struct list_head ni_netlist;
406 /* chain on the recovery queue */
407 struct list_head ni_recovery;
409 /* MD handle for recovery ping */
410 struct lnet_handle_md ni_ping_mdh;
417 /* bond NI on some CPTs */
420 /* interface's NID */
423 /* instance-specific data */
427 atomic_t ni_tx_credits;
429 /* percpt TX queues */
430 struct lnet_tx_queue **ni_tx_queues;
432 /* percpt reference count */
435 /* pointer to parent network */
436 struct lnet_net *ni_net;
438 /* my health status */
439 struct lnet_ni_status *ni_status;
441 /* NI FSM. Protected by lnet_ni_lock() */
442 enum lnet_ni_state ni_state;
444 /* Recovery state. Protected by lnet_ni_lock() */
445 __u32 ni_recovery_state;
447 /* per NI LND tunables */
448 struct lnet_lnd_tunables ni_lnd_tunables;
450 /* lnd tunables set explicitly */
451 bool ni_lnd_tunables_set;
454 struct lnet_element_stats ni_stats;
455 struct lnet_health_local_stats ni_hstats;
457 /* physical device CPT */
460 /* sequence number used to round robin over nis within a net */
465 * initialized to LNET_MAX_HEALTH_VALUE
466 * Value is decremented every time we fail to send a message over
467 * this NI because of a NI specific failure.
468 * Value is incremented if we successfully send a message.
473 * Set to 1 by the LND when it receives an event telling it the device
474 * has gone into a fatal state. Set to 0 when the LND receives an
475 * even telling it the device is back online.
477 atomic_t ni_fatal_error_on;
480 * equivalent interfaces to use
481 * This is an array because socklnd bonding can still be configured
483 char *ni_interfaces[LNET_INTERFACES_NUM];
484 struct net *ni_net_ns; /* original net namespace */
487 #define LNET_PROTO_PING_MATCHBITS 0x8000000000000000LL
490 * Descriptor of a ping info buffer: keep a separate indicator of the
491 * size and a reference count. The type is used both as a source and
492 * sink of data, so we need to keep some information outside of the
493 * area that may be overwritten by network data.
495 struct lnet_ping_buffer {
499 struct lnet_ping_info pb_info;
502 #define LNET_PING_BUFFER_SIZE(NNIDS) \
503 offsetof(struct lnet_ping_buffer, pb_info.pi_ni[NNIDS])
504 #define LNET_PING_BUFFER_LONI(PBUF) ((PBUF)->pb_info.pi_ni[0].ns_nid)
505 #define LNET_PING_BUFFER_SEQNO(PBUF) ((PBUF)->pb_info.pi_ni[0].ns_status)
507 #define LNET_PING_INFO_TO_BUFFER(PINFO) \
508 container_of((PINFO), struct lnet_ping_buffer, pb_info)
510 struct lnet_peer_ni {
511 /* chain on lpn_peer_nis */
512 struct list_head lpni_peer_nis;
513 /* chain on remote peer list */
514 struct list_head lpni_on_remote_peer_ni_list;
515 /* chain on recovery queue */
516 struct list_head lpni_recovery;
517 /* chain on peer hash */
518 struct list_head lpni_hashlist;
519 /* messages blocking for tx credits */
520 struct list_head lpni_txq;
521 /* pointer to peer net I'm part of */
522 struct lnet_peer_net *lpni_peer_net;
523 /* statistics kept on each peer NI */
524 struct lnet_element_stats lpni_stats;
525 struct lnet_health_remote_stats lpni_hstats;
526 /* spin lock protecting credits and lpni_txq */
527 spinlock_t lpni_lock;
528 /* # tx credits available */
531 int lpni_mintxcredits;
533 * Each peer_ni in a gateway maintains its own credits. This
534 * allows more traffic to gateways that have multiple interfaces.
536 /* # router credits */
539 int lpni_minrtrcredits;
540 /* bytes queued for sending */
542 /* network peer is on */
543 struct lnet_net *lpni_net;
547 atomic_t lpni_refcount;
548 /* health value for the peer */
549 atomic_t lpni_healthv;
550 /* recovery ping mdh */
551 struct lnet_handle_md lpni_recovery_ping_mdh;
552 /* CPT this peer attached on */
554 /* state flags -- protected by lpni_lock */
556 /* status of the peer NI as reported by the peer */
557 __u32 lpni_ns_status;
558 /* sequence number used to round robin over peer nis within a net */
560 /* sequence number used to round robin over gateways */
562 /* returned RC ping features. Protected with lpni_lock */
563 unsigned int lpni_ping_feats;
564 /* time last message was received from the peer */
565 time64_t lpni_last_alive;
566 /* preferred local nids: if only one, use lpni_pref.nid */
571 /* number of preferred NIDs in lnpi_pref_nids */
572 __u32 lpni_pref_nnids;
575 /* Preferred path added due to traffic on non-MR peer_ni */
576 #define LNET_PEER_NI_NON_MR_PREF (1 << 0)
577 /* peer is being recovered. */
578 #define LNET_PEER_NI_RECOVERY_PENDING (1 << 1)
579 /* recovery ping failed */
580 #define LNET_PEER_NI_RECOVERY_FAILED (1 << 2)
581 /* peer is being deleted */
582 #define LNET_PEER_NI_DELETING (1 << 3)
585 /* chain on pt_peer_list */
586 struct list_head lp_peer_list;
588 /* list of peer nets */
589 struct list_head lp_peer_nets;
591 /* list of messages pending discovery*/
592 struct list_head lp_dc_pendq;
594 /* chain on router list */
595 struct list_head lp_rtr_list;
597 /* primary NID of the peer */
598 lnet_nid_t lp_primary_nid;
600 /* net to perform discovery on */
601 __u32 lp_disc_net_id;
603 /* CPT of peer_table */
606 /* number of NIDs on this peer */
609 /* # refs from lnet_route::lr_gateway */
613 * peer specific health sensitivity value to decrement peer nis in
614 * this peer with if set to something other than 0
616 __u32 lp_health_sensitivity;
618 /* messages blocking for router credits */
619 struct list_head lp_rtrq;
621 /* routes on this peer */
622 struct list_head lp_routes;
624 /* reference count */
625 atomic_t lp_refcount;
627 /* lock protecting peer state flags and lpni_rtrq */
630 /* peer state flags */
633 /* buffer for data pushed by peer */
634 struct lnet_ping_buffer *lp_data;
636 /* MD handle for ping in progress */
637 struct lnet_handle_md lp_ping_mdh;
639 /* MD handle for push in progress */
640 struct lnet_handle_md lp_push_mdh;
642 /* number of NIDs for sizing push data */
645 /* NI config sequence number of peer */
648 /* Local NI config sequence number acked by peer */
651 /* Local NI config sequence number sent to peer */
652 __u32 lp_node_seqno_sent;
654 /* Ping error encountered during discovery. */
657 /* Push error encountered during discovery. */
660 /* Error encountered during discovery. */
663 /* time it was put on the ln_dc_working queue */
664 time64_t lp_last_queued;
666 /* link on discovery-related lists */
667 struct list_head lp_dc_list;
669 /* tasks waiting on discovery of this peer */
670 wait_queue_head_t lp_dc_waitq;
672 /* cached peer aliveness */
677 * The status flags in lp_state. Their semantics have chosen so that
678 * lp_state can be zero-initialized.
680 * A peer is marked MULTI_RAIL in two cases: it was configured using DLC
681 * as multi-rail aware, or the LNET_PING_FEAT_MULTI_RAIL bit was set.
683 * A peer is marked NO_DISCOVERY if the LNET_PING_FEAT_DISCOVERY bit was
684 * NOT set when the peer was pinged by discovery.
686 * A peer is marked ROUTER if it indicates so in the feature bit.
688 #define LNET_PEER_MULTI_RAIL (1 << 0) /* Multi-rail aware */
689 #define LNET_PEER_NO_DISCOVERY (1 << 1) /* Peer disabled discovery */
690 #define LNET_PEER_ROUTER_ENABLED (1 << 2) /* router feature enabled */
693 * A peer is marked CONFIGURED if it was configured by DLC.
695 * In addition, a peer is marked DISCOVERED if it has fully passed
696 * through Peer Discovery.
698 * When Peer Discovery is disabled, the discovery thread will mark
699 * peers REDISCOVER to indicate that they should be re-examined if
700 * discovery is (re)enabled on the node.
702 * A peer that was created as the result of inbound traffic will not
705 #define LNET_PEER_CONFIGURED (1 << 3) /* Configured via DLC */
706 #define LNET_PEER_DISCOVERED (1 << 4) /* Peer was discovered */
707 #define LNET_PEER_REDISCOVER (1 << 5) /* Discovery was disabled */
709 * A peer is marked DISCOVERING when discovery is in progress.
710 * The other flags below correspond to stages of discovery.
712 #define LNET_PEER_DISCOVERING (1 << 6) /* Discovering */
713 #define LNET_PEER_DATA_PRESENT (1 << 7) /* Remote peer data present */
714 #define LNET_PEER_NIDS_UPTODATE (1 << 8) /* Remote peer info uptodate */
715 #define LNET_PEER_PING_SENT (1 << 9) /* Waiting for REPLY to Ping */
716 #define LNET_PEER_PUSH_SENT (1 << 10) /* Waiting for ACK of Push */
717 #define LNET_PEER_PING_FAILED (1 << 11) /* Ping send failure */
718 #define LNET_PEER_PUSH_FAILED (1 << 12) /* Push send failure */
720 * A ping can be forced as a way to fix up state, or as a manual
721 * intervention by an admin.
722 * A push can be forced in circumstances that would normally not
723 * allow for one to happen.
725 #define LNET_PEER_FORCE_PING (1 << 13) /* Forced Ping */
726 #define LNET_PEER_FORCE_PUSH (1 << 14) /* Forced Push */
728 /* force delete even if router */
729 #define LNET_PEER_RTR_NI_FORCE_DEL (1 << 15)
731 /* gw undergoing alive discovery */
732 #define LNET_PEER_RTR_DISCOVERY (1 << 16)
733 /* gw has undergone discovery (does not indicate success or failure) */
734 #define LNET_PEER_RTR_DISCOVERED (1 << 17)
736 /* peer is marked for deletion */
737 #define LNET_PEER_MARK_DELETION (1 << 18)
739 struct lnet_peer_net {
740 /* chain on lp_peer_nets */
741 struct list_head lpn_peer_nets;
743 /* list of peer_nis on this network */
744 struct list_head lpn_peer_nis;
746 /* pointer to the peer I'm part of */
747 struct lnet_peer *lpn_peer;
752 /* peer net health */
755 /* time of last router net check attempt */
756 time64_t lpn_rtrcheck_timestamp;
758 /* selection sequence number */
761 /* reference count */
762 atomic_t lpn_refcount;
766 #define LNET_PEER_HASH_BITS 9
767 #define LNET_PEER_HASH_SIZE (1 << LNET_PEER_HASH_BITS)
770 * peer hash table - one per CPT
772 * protected by lnet_net_lock/EX for update
777 * protected by pt_zombie_lock:
781 * pt_zombie lock nests inside lnet_net_lock
783 struct lnet_peer_table {
784 int pt_version; /* /proc validity stamp */
785 struct list_head *pt_hash; /* NID->peer hash */
786 struct list_head pt_peer_list; /* peers */
787 int pt_peers; /* # peers */
788 struct list_head pt_zombie_list; /* zombie peer_ni */
789 int pt_zombies; /* # zombie peers_ni */
790 spinlock_t pt_zombie_lock; /* protect list and count */
793 /* peer aliveness is enabled only on routers for peers in a network where the
794 * struct lnet_ni::ni_peertimeout has been set to a positive value
796 #define lnet_peer_aliveness_enabled(lp) (the_lnet.ln_routing != 0 && \
797 ((lp)->lpni_net) && \
798 (lp)->lpni_net->net_tunables.lct_peer_timeout > 0)
801 struct list_head lr_list; /* chain on net */
802 struct list_head lr_gwlist; /* chain on gateway */
803 struct lnet_peer *lr_gateway; /* router node */
804 lnet_nid_t lr_nid; /* NID used to add route */
805 __u32 lr_net; /* remote network number */
806 __u32 lr_lnet; /* local network number */
807 int lr_seq; /* sequence for round-robin */
808 __u32 lr_hops; /* how far I am */
809 unsigned int lr_priority; /* route priority */
810 bool lr_alive; /* cached route aliveness */
811 bool lr_single_hop; /* this route is single-hop */
814 #define LNET_REMOTE_NETS_HASH_DEFAULT (1U << 7)
815 #define LNET_REMOTE_NETS_HASH_MAX (1U << 16)
816 #define LNET_REMOTE_NETS_HASH_SIZE (1 << the_lnet.ln_remote_nets_hbits)
818 struct lnet_remotenet {
819 /* chain on ln_remote_nets_hash */
820 struct list_head lrn_list;
822 struct list_head lrn_routes;
827 /** lnet message has credit and can be submitted to lnd for send/receive */
828 #define LNET_CREDIT_OK 0
829 /** lnet message is waiting for credit */
830 #define LNET_CREDIT_WAIT 1
831 /** lnet message is waiting for discovery */
832 #define LNET_DC_WAIT 2
834 struct lnet_rtrbufpool {
835 /* my free buffer pool */
836 struct list_head rbp_bufs;
837 /* messages blocking for a buffer */
838 struct list_head rbp_msgs;
839 /* # pages in each buffer */
841 /* requested number of buffers */
842 int rbp_req_nbuffers;
843 /* # buffers actually allocated */
845 /* # free buffers / blocked messages */
852 struct list_head rb_list; /* chain on rbp_bufs */
853 struct lnet_rtrbufpool *rb_pool; /* owning pool */
854 struct bio_vec rb_kiov[0]; /* the buffer space */
857 #define LNET_PEER_HASHSIZE 503 /* prime! */
859 enum lnet_match_flags {
860 /* Didn't match anything */
861 LNET_MATCHMD_NONE = (1 << 0),
863 LNET_MATCHMD_OK = (1 << 1),
864 /* Must be discarded */
865 LNET_MATCHMD_DROP = (1 << 2),
866 /* match and buffer is exhausted */
867 LNET_MATCHMD_EXHAUSTED = (1 << 3),
869 LNET_MATCHMD_FINISH = (LNET_MATCHMD_OK | LNET_MATCHMD_DROP),
872 /* Options for struct lnet_portal::ptl_options */
873 #define LNET_PTL_LAZY (1 << 0)
874 #define LNET_PTL_MATCH_UNIQUE (1 << 1) /* unique match, for RDMA */
875 #define LNET_PTL_MATCH_WILDCARD (1 << 2) /* wildcard match, request portal */
877 /* parameter for matching operations (GET, PUT) */
878 struct lnet_match_info {
880 struct lnet_process_id mi_id;
883 unsigned int mi_portal;
884 unsigned int mi_rlength;
885 unsigned int mi_roffset;
888 /* ME hash of RDMA portal */
889 #define LNET_MT_HASH_BITS 8
890 #define LNET_MT_HASH_SIZE (1 << LNET_MT_HASH_BITS)
891 #define LNET_MT_HASH_MASK (LNET_MT_HASH_SIZE - 1)
892 /* we allocate (LNET_MT_HASH_SIZE + 1) entries for lnet_match_table::mt_hash,
893 * the last entry is reserved for MEs with ignore-bits */
894 #define LNET_MT_HASH_IGNORE LNET_MT_HASH_SIZE
895 /* __u64 has 2^6 bits, so need 2^(LNET_MT_HASH_BITS - LNET_MT_BITS_U64) which
896 * is 4 __u64s as bit-map, and add an extra __u64 (only use one bit) for the
897 * ME-list with ignore-bits, which is mtable::mt_hash[LNET_MT_HASH_IGNORE] */
898 #define LNET_MT_BITS_U64 6 /* 2^6 bits */
899 #define LNET_MT_EXHAUSTED_BITS (LNET_MT_HASH_BITS - LNET_MT_BITS_U64)
900 #define LNET_MT_EXHAUSTED_BMAP ((1 << LNET_MT_EXHAUSTED_BITS) + 1)
902 /* portal match table */
903 struct lnet_match_table {
904 /* reserved for upcoming patches, CPU partition ID */
906 unsigned int mt_portal; /* portal index */
907 /* match table is set as "enabled" if there's non-exhausted MD
908 * attached on mt_mhash, it's only valid for wildcard portal */
909 unsigned int mt_enabled;
910 /* bitmap to flag whether MEs on mt_hash are exhausted or not */
911 __u64 mt_exhausted[LNET_MT_EXHAUSTED_BMAP];
912 struct list_head *mt_mhash; /* matching hash */
915 /* these are only useful for wildcard portal */
916 /* Turn off message rotor for wildcard portals */
917 #define LNET_PTL_ROTOR_OFF 0
918 /* round-robin dispatch all PUT messages for wildcard portals */
919 #define LNET_PTL_ROTOR_ON 1
920 /* round-robin dispatch routed PUT message for wildcard portals */
921 #define LNET_PTL_ROTOR_RR_RT 2
922 /* dispatch routed PUT message by hashing source NID for wildcard portals */
923 #define LNET_PTL_ROTOR_HASH_RT 3
927 unsigned int ptl_index; /* portal ID, reserved */
928 /* flags on this portal: lazy, unique... */
929 unsigned int ptl_options;
930 /* list of messages which are stealing buffer */
931 struct list_head ptl_msg_stealing;
932 /* messages blocking for MD */
933 struct list_head ptl_msg_delayed;
934 /* Match table for each CPT */
935 struct lnet_match_table **ptl_mtables;
936 /* spread rotor of incoming "PUT" */
937 unsigned int ptl_rotor;
938 /* # active entries for this portal */
940 /* array of active entries' cpu-partition-id */
944 #define LNET_LH_HASH_BITS 12
945 #define LNET_LH_HASH_SIZE (1ULL << LNET_LH_HASH_BITS)
946 #define LNET_LH_HASH_MASK (LNET_LH_HASH_SIZE - 1)
948 /* resource container (ME, MD, EQ) */
949 struct lnet_res_container {
950 unsigned int rec_type; /* container type */
951 __u64 rec_lh_cookie; /* cookie generator */
952 struct list_head rec_active; /* active resource list */
953 struct list_head *rec_lh_hash; /* handle hash */
956 /* message container */
957 struct lnet_msg_container {
958 int msc_init; /* initialized or not */
959 /* max # threads finalizing */
961 /* msgs waiting to complete finalizing */
962 struct list_head msc_finalizing;
963 /* msgs waiting to be resent */
964 struct list_head msc_resending;
965 struct list_head msc_active; /* active message list */
966 /* threads doing finalization */
967 void **msc_finalizers;
968 /* threads doing resends */
969 void **msc_resenders;
972 /* Peer Discovery states */
973 #define LNET_DC_STATE_SHUTDOWN 0 /* not started */
974 #define LNET_DC_STATE_RUNNING 1 /* started up OK */
975 #define LNET_DC_STATE_STOPPING 2 /* telling thread to stop */
977 /* Router Checker states */
978 #define LNET_MT_STATE_SHUTDOWN 0 /* not started */
979 #define LNET_MT_STATE_RUNNING 1 /* started up OK */
980 #define LNET_MT_STATE_STOPPING 2 /* telling thread to stop */
983 #define LNET_STATE_SHUTDOWN 0 /* not started */
984 #define LNET_STATE_RUNNING 1 /* started up OK */
985 #define LNET_STATE_STOPPING 2 /* telling thread to stop */
988 /* CPU partition table of LNet */
989 struct cfs_cpt_table *ln_cpt_table;
990 /* number of CPTs in ln_cpt_table */
991 unsigned int ln_cpt_number;
992 unsigned int ln_cpt_bits;
994 /* protect LNet resources (ME/MD/EQ) */
995 struct cfs_percpt_lock *ln_res_lock;
998 /* the vector of portals */
999 struct lnet_portal **ln_portals;
1000 /* percpt MD container */
1001 struct lnet_res_container **ln_md_containers;
1003 /* Event Queue container */
1004 struct lnet_res_container ln_eq_container;
1005 spinlock_t ln_eq_wait_lock;
1007 unsigned int ln_remote_nets_hbits;
1009 /* protect NI, peer table, credits, routers, rtrbuf... */
1010 struct cfs_percpt_lock *ln_net_lock;
1011 /* percpt message containers for active/finalizing/freed message */
1012 struct lnet_msg_container **ln_msg_containers;
1013 struct lnet_counters **ln_counters;
1014 struct lnet_peer_table **ln_peer_tables;
1015 /* list of peer nis not on a local network */
1016 struct list_head ln_remote_peer_ni_list;
1017 /* failure simulation */
1018 struct list_head ln_test_peers;
1019 struct list_head ln_drop_rules;
1020 struct list_head ln_delay_rules;
1022 struct list_head ln_nets;
1023 /* the loopback NI */
1024 struct lnet_ni *ln_loni;
1025 /* network zombie list */
1026 struct list_head ln_net_zombie;
1027 /* resend messages list */
1028 struct list_head ln_msg_resend;
1029 /* spin lock to protect the msg resend list */
1030 spinlock_t ln_msg_resend_lock;
1032 /* remote networks with routes to them */
1033 struct list_head *ln_remote_nets_hash;
1034 /* validity stamp */
1035 __u64 ln_remote_nets_version;
1036 /* list of all known routers */
1037 struct list_head ln_routers;
1038 /* validity stamp */
1039 __u64 ln_routers_version;
1040 /* percpt router buffer pools */
1041 struct lnet_rtrbufpool **ln_rtrpools;
1044 * Ping target / Push source
1046 * The ping target and push source share a single buffer. The
1047 * ln_ping_target is protected against concurrent updates by
1050 struct lnet_handle_md ln_ping_target_md;
1051 lnet_handler_t ln_ping_target_handler;
1052 struct lnet_ping_buffer *ln_ping_target;
1053 atomic_t ln_ping_target_seqno;
1058 * ln_push_nnis contains the desired size of the push target.
1059 * The lnet_net_lock is used to handle update races. The old
1060 * buffer may linger a while after it has been unlinked, in
1061 * which case the event handler cleans up.
1063 lnet_handler_t ln_push_target_handler;
1064 struct lnet_handle_md ln_push_target_md;
1065 struct lnet_ping_buffer *ln_push_target;
1066 int ln_push_target_nnis;
1068 /* discovery event queue handle */
1069 lnet_handler_t ln_dc_handler;
1070 /* discovery requests */
1071 struct list_head ln_dc_request;
1072 /* discovery working list */
1073 struct list_head ln_dc_working;
1074 /* discovery expired list */
1075 struct list_head ln_dc_expired;
1076 /* discovery thread wait queue */
1077 wait_queue_head_t ln_dc_waitq;
1078 /* discovery startup/shutdown state */
1081 /* monitor thread startup/shutdown state */
1083 /* serialise startup/shutdown */
1084 struct semaphore ln_mt_signal;
1086 struct mutex ln_api_mutex;
1087 struct mutex ln_lnd_mutex;
1088 /* Have I called LNetNIInit myself? */
1090 /* LNetNIInit/LNetNIFini counter */
1092 /* SHUTDOWN/RUNNING/STOPPING */
1095 int ln_routing; /* am I a router? */
1096 lnet_pid_t ln_pid; /* requested pid */
1097 /* uniquely identifies this ni in this epoch */
1098 __u64 ln_interface_cookie;
1099 /* registered LNDs */
1100 const struct lnet_lnd *ln_lnds[NUM_LNDS];
1102 /* test protocol compatibility flags */
1103 unsigned long ln_testprotocompat;
1105 /* 0 - load the NIs from the mod params
1106 * 1 - do not load the NIs from the mod params
1107 * Reverse logic to ensure that other calls to LNetNIInit
1110 bool ln_nis_from_mod_params;
1113 * completion for the monitor thread. The monitor thread takes care of
1114 * checking routes, timedout messages and resending messages.
1116 struct completion ln_mt_wait_complete;
1118 /* per-cpt resend queues */
1119 struct list_head **ln_mt_resendqs;
1120 /* local NIs to recover */
1121 struct list_head ln_mt_localNIRecovq;
1122 /* local NIs to recover */
1123 struct list_head ln_mt_peerNIRecovq;
1125 * An array of queues for GET/PUT waiting for REPLY/ACK respectively.
1126 * There are CPT number of queues. Since response trackers will be
1127 * added on the fast path we can't afford to grab the exclusive
1128 * net lock to protect these queues. The CPT will be calculated
1129 * based on the mdh cookie.
1131 struct list_head **ln_mt_rstq;
1133 * A response tracker becomes a zombie when the associated MD is queued
1134 * for unlink before the response tracker is detached from the MD. An
1135 * entry on a zombie list can be freed when either the remaining
1136 * operations on the MD complete or when LNet has shut down.
1138 struct list_head **ln_mt_zombie_rstqs;
1139 /* recovery handler */
1140 lnet_handler_t ln_mt_handler;
1143 * Completed when the discovery and monitor threads can enter their
1146 struct completion ln_started;