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/
31 * lnet/include/lnet/lib-lnet.h
33 * Top level include for library side routines
36 #ifndef __LNET_LIB_LNET_H__
37 #define __LNET_LIB_LNET_H__
40 #define CFS_FAIL_PTLRPC_OST_BULK_CB2 0xe000
42 #include <linux/netdevice.h>
44 #include <libcfs/libcfs.h>
46 #include <lnet/lib-types.h>
47 #include <uapi/linux/lnet/lnet-dlc.h>
48 #include <uapi/linux/lnet/lnet-types.h>
49 #include <uapi/linux/lnet/lnetctl.h>
50 #include <uapi/linux/lnet/nidstr.h>
52 extern struct lnet the_lnet; /* THE network */
54 #if (BITS_PER_LONG == 32)
55 /* 2 CPTs, allowing more CPTs might make us under memory pressure */
56 # define LNET_CPT_MAX_BITS 1
58 #else /* 64-bit system */
60 * 256 CPTs for thousands of CPUs, allowing more CPTs might make us
61 * under risk of consuming all lh_cookie.
63 # define LNET_CPT_MAX_BITS 8
64 #endif /* BITS_PER_LONG == 32 */
66 /* max allowed CPT number */
67 #define LNET_CPT_MAX (1 << LNET_CPT_MAX_BITS)
69 #define LNET_CPT_NUMBER (the_lnet.ln_cpt_number)
70 #define LNET_CPT_BITS (the_lnet.ln_cpt_bits)
71 #define LNET_CPT_MASK ((1ULL << LNET_CPT_BITS) - 1)
74 #define LNET_LOCK_EX CFS_PERCPT_LOCK_EX
76 /* default timeout and credits */
77 #define DEFAULT_PEER_TIMEOUT 180
78 #define DEFAULT_PEER_CREDITS 8
79 #define DEFAULT_CREDITS 256
81 /* default number of connections per peer */
82 #define DEFAULT_CONNS_PER_PEER 0
84 #ifdef HAVE_KERN_SOCK_GETNAME_2ARGS
85 #define lnet_kernel_getpeername(sock, addr, addrlen) \
86 kernel_getpeername(sock, addr)
87 #define lnet_kernel_getsockname(sock, addr, addrlen) \
88 kernel_getsockname(sock, addr)
90 #define lnet_kernel_getpeername(sock, addr, addrlen) \
91 kernel_getpeername(sock, addr, addrlen)
92 #define lnet_kernel_getsockname(sock, addr, addrlen) \
93 kernel_getsockname(sock, addr, addrlen)
97 * kernel 5.3: commit ef11db3310e272d3d8dbe8739e0770820dd20e52
98 * kernel 4.18.0-193.el8:
99 * added in_dev_for_each_ifa_rtnl and in_dev_for_each_ifa_rcu
100 * and removed for_ifa and endfor_ifa.
101 * Use the _rntl variant as the current locking is rtnl.
103 #ifdef HAVE_IN_DEV_FOR_EACH_IFA_RTNL
104 #define DECLARE_CONST_IN_IFADDR(ifa) const struct in_ifaddr *ifa
105 #define endfor_ifa(in_dev)
107 #define DECLARE_CONST_IN_IFADDR(ifa)
108 #define in_dev_for_each_ifa_rtnl(ifa, in_dev) for_ifa((in_dev))
109 #define in_dev_for_each_ifa_rcu(ifa, in_dev) for_ifa((in_dev))
113 #define fallthrough do {} while (0) /* fallthrough */
116 int choose_ipv4_src(__u32 *ret,
117 int interface, __u32 dst_ipaddr, struct net *ns);
119 bool lnet_is_route_alive(struct lnet_route *route);
120 bool lnet_is_gateway_alive(struct lnet_peer *gw);
122 static inline int lnet_is_wire_handle_none(struct lnet_handle_wire *wh)
124 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
125 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
128 static inline int lnet_md_exhausted(struct lnet_libmd *md)
130 return (md->md_threshold == 0 ||
131 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
132 md->md_offset + md->md_max_size > md->md_length));
135 static inline int lnet_md_unlinkable(struct lnet_libmd *md)
137 /* Should unlink md when its refcount is 0 and either:
138 * - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
139 * in the latter case md may not be exhausted).
140 * - auto unlink is on and md is exhausted.
142 if (md->md_refcount != 0)
145 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
148 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
149 lnet_md_exhausted(md));
152 #define lnet_cpt_table() (the_lnet.ln_cpt_table)
153 #define lnet_cpt_current() cfs_cpt_current(the_lnet.ln_cpt_table, 1)
156 lnet_cpt_of_cookie(__u64 cookie)
158 unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
160 /* LNET_CPT_NUMBER doesn't have to be power2, which means we can
161 * get illegal cpt from it's invalid cookie */
162 return cpt < LNET_CPT_NUMBER ? cpt : cpt % LNET_CPT_NUMBER;
166 lnet_res_lock(int cpt)
168 cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
172 lnet_res_unlock(int cpt)
174 cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
178 lnet_res_lock_current(void)
180 int cpt = lnet_cpt_current();
187 lnet_net_lock(int cpt)
189 cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
193 lnet_net_unlock(int cpt)
195 cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
199 lnet_net_lock_current(void)
201 int cpt = lnet_cpt_current();
207 #define LNET_LOCK() lnet_net_lock(LNET_LOCK_EX)
208 #define LNET_UNLOCK() lnet_net_unlock(LNET_LOCK_EX)
210 #define lnet_ptl_lock(ptl) spin_lock(&(ptl)->ptl_lock)
211 #define lnet_ptl_unlock(ptl) spin_unlock(&(ptl)->ptl_lock)
212 #define lnet_ni_lock(ni) spin_lock(&(ni)->ni_lock)
213 #define lnet_ni_unlock(ni) spin_unlock(&(ni)->ni_lock)
215 #define MAX_PORTALS 64
217 #define LNET_SMALL_MD_SIZE offsetof(struct lnet_libmd, md_kiov[1])
218 extern struct kmem_cache *lnet_mes_cachep; /* MEs kmem_cache */
219 extern struct kmem_cache *lnet_small_mds_cachep; /* <= LNET_SMALL_MD_SIZE bytes
221 extern struct kmem_cache *lnet_udsp_cachep;
222 extern struct kmem_cache *lnet_rspt_cachep;
223 extern struct kmem_cache *lnet_msg_cachep;
226 lnet_ni_set_status_locked(struct lnet_ni *ni, __u32 status)
227 __must_hold(&ni->ni_lock)
231 if (ni->ni_status && ni->ni_status->ns_status != status) {
232 CDEBUG(D_NET, "ni %s status changed from %#x to %#x\n",
233 libcfs_nidstr(&ni->ni_nid),
234 ni->ni_status->ns_status, status);
235 ni->ni_status->ns_status = status;
242 static inline unsigned int
243 lnet_ni_get_status_locked(struct lnet_ni *ni)
244 __must_hold(&ni->ni_lock)
246 if (nid_is_lo0(&ni->ni_nid))
247 return LNET_NI_STATUS_UP;
248 else if (atomic_read(&ni->ni_fatal_error_on))
249 return LNET_NI_STATUS_DOWN;
250 else if (ni->ni_status)
251 return ni->ni_status->ns_status;
253 return LNET_NI_STATUS_UP;
257 lnet_ni_set_status(struct lnet_ni *ni, __u32 status)
262 update = lnet_ni_set_status_locked(ni, status);
268 static inline void lnet_md_wait_handling(struct lnet_libmd *md, int cpt)
270 wait_queue_head_t *wq = __var_waitqueue(md);
271 #if defined(HAVE_WAIT_BIT_QUEUE_ENTRY) || !defined(HAVE_WAIT_VAR_EVENT)
272 struct wait_bit_queue_entry entry;
273 wait_queue_entry_t *wqe = &entry.wq_entry;
275 struct wait_bit_queue entry;
276 wait_queue_entry_t *wqe = &entry.wait;
278 init_wait_var_entry(&entry, md, 0);
279 prepare_to_wait_event(wq, wqe, TASK_IDLE);
280 if (md->md_flags & LNET_MD_FLAG_HANDLING) {
281 /* Race with unlocked call to ->md_handler.
282 * It is safe to drop the res_lock here as the
283 * caller has only just claimed it.
285 lnet_res_unlock(cpt);
287 /* Cannot check md now, it might be freed. Caller
288 * must reclaim reference and check.
292 finish_wait(wq, wqe);
296 lnet_md_free(struct lnet_libmd *md)
300 LASSERTF(md->md_rspt_ptr == NULL, "md %p rsp %p\n", md, md->md_rspt_ptr);
302 size = offsetof(struct lnet_libmd, md_kiov[md->md_niov]);
304 if (size <= LNET_SMALL_MD_SIZE) {
305 CDEBUG(D_MALLOC, "slab-freed 'md' at %p.\n", md);
306 kmem_cache_free(lnet_small_mds_cachep, md);
308 LIBCFS_FREE(md, size);
312 struct lnet_libhandle *lnet_res_lh_lookup(struct lnet_res_container *rec,
314 void lnet_res_lh_initialize(struct lnet_res_container *rec,
315 struct lnet_libhandle *lh);
317 lnet_res_lh_invalidate(struct lnet_libhandle *lh)
319 /* ALWAYS called with resource lock held */
320 /* NB: cookie is still useful, don't reset it */
321 list_del(&lh->lh_hash_chain);
325 lnet_md2handle(struct lnet_handle_md *handle, struct lnet_libmd *md)
327 handle->cookie = md->md_lh.lh_cookie;
330 static inline struct lnet_libmd *
331 lnet_handle2md(struct lnet_handle_md *handle)
333 /* ALWAYS called with resource lock held */
334 struct lnet_libhandle *lh;
337 cpt = lnet_cpt_of_cookie(handle->cookie);
338 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
343 return lh_entry(lh, struct lnet_libmd, md_lh);
346 static inline struct lnet_libmd *
347 lnet_wire_handle2md(struct lnet_handle_wire *wh)
349 /* ALWAYS called with resource lock held */
350 struct lnet_libhandle *lh;
353 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
356 cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
357 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
358 wh->wh_object_cookie);
362 return lh_entry(lh, struct lnet_libmd, md_lh);
366 lnet_peer_net_addref_locked(struct lnet_peer_net *lpn)
368 atomic_inc(&lpn->lpn_refcount);
371 extern void lnet_destroy_peer_net_locked(struct lnet_peer_net *lpn);
374 lnet_peer_net_decref_locked(struct lnet_peer_net *lpn)
376 if (atomic_dec_and_test(&lpn->lpn_refcount))
377 lnet_destroy_peer_net_locked(lpn);
381 lnet_peer_addref_locked(struct lnet_peer *lp)
383 atomic_inc(&lp->lp_refcount);
386 extern void lnet_destroy_peer_locked(struct lnet_peer *lp);
389 lnet_peer_decref_locked(struct lnet_peer *lp)
391 if (atomic_dec_and_test(&lp->lp_refcount))
392 lnet_destroy_peer_locked(lp);
396 lnet_peer_ni_addref_locked(struct lnet_peer_ni *lp)
398 kref_get(&lp->lpni_kref);
401 extern void lnet_destroy_peer_ni_locked(struct kref *ref);
404 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
406 kref_put(&lp->lpni_kref, lnet_destroy_peer_ni_locked);
410 lnet_isrouter(struct lnet_peer_ni *lpni)
412 return lpni->lpni_peer_net->lpn_peer->lp_rtr_refcount != 0;
416 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
418 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
419 LASSERT(*ni->ni_refs[cpt] >= 0);
421 (*ni->ni_refs[cpt])++;
425 lnet_ni_addref(struct lnet_ni *ni)
428 lnet_ni_addref_locked(ni, 0);
433 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
435 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
436 LASSERT(*ni->ni_refs[cpt] > 0);
438 (*ni->ni_refs[cpt])--;
442 lnet_ni_decref(struct lnet_ni *ni)
445 lnet_ni_decref_locked(ni, 0);
449 static inline struct lnet_msg *
452 struct lnet_msg *msg;
454 msg = kmem_cache_zalloc(lnet_msg_cachep, GFP_NOFS);
460 lnet_msg_free(struct lnet_msg *msg)
462 LASSERT(!msg->msg_onactivelist);
463 kmem_cache_free(lnet_msg_cachep, msg);
466 static inline struct lnet_rsp_tracker *
467 lnet_rspt_alloc(int cpt)
469 struct lnet_rsp_tracker *rspt;
471 rspt = kmem_cache_zalloc(lnet_rspt_cachep, GFP_NOFS);
474 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc++;
475 lnet_net_unlock(cpt);
477 CDEBUG(D_MALLOC, "rspt alloc %p\n", rspt);
482 lnet_rspt_free(struct lnet_rsp_tracker *rspt, int cpt)
484 CDEBUG(D_MALLOC, "rspt free %p\n", rspt);
486 kmem_cache_free(lnet_rspt_cachep, rspt);
488 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc--;
489 lnet_net_unlock(cpt);
492 void lnet_ni_free(struct lnet_ni *ni);
493 void lnet_net_free(struct lnet_net *net);
496 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
499 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
502 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
506 lnet_nid2peerhash(struct lnet_nid *nid)
511 for (i = 0; i < 4; i++)
512 h = hash_32(nid->nid_addr[i]^h, 32);
513 return hash_32(LNET_NID_NET(nid) ^ h, LNET_PEER_HASH_BITS);
516 static inline struct list_head *
517 lnet_net2rnethash(__u32 net)
519 return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
521 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
524 static inline void lnet_hdr_from_nid4(struct lnet_hdr *hdr,
525 const struct lnet_hdr_nid4 *vhdr)
527 const struct _lnet_hdr_nid4 *hdr_nid4 = (void *)vhdr;
529 lnet_nid4_to_nid(le64_to_cpu(hdr_nid4->dest_nid), &hdr->dest_nid);
530 lnet_nid4_to_nid(le64_to_cpu(hdr_nid4->src_nid), &hdr->src_nid);
531 hdr->dest_pid = le32_to_cpu(hdr_nid4->dest_pid);
532 hdr->src_pid = le32_to_cpu(hdr_nid4->src_pid);
533 hdr->type = le32_to_cpu(hdr_nid4->type);
534 hdr->payload_length = le32_to_cpu(hdr_nid4->payload_length);
536 hdr->msg = hdr_nid4->msg;
539 static inline void lnet_hdr_to_nid4(const struct lnet_hdr *hdr,
540 struct lnet_hdr_nid4 *vhdr)
542 struct _lnet_hdr_nid4 *hdr_nid4 = (void *)vhdr;
544 hdr_nid4->dest_nid = cpu_to_le64(lnet_nid_to_nid4(&hdr->dest_nid));
545 hdr_nid4->src_nid = cpu_to_le64(lnet_nid_to_nid4(&hdr->src_nid));
546 hdr_nid4->dest_pid = cpu_to_le32(hdr->dest_pid);
547 hdr_nid4->src_pid = cpu_to_le32(hdr->src_pid);
548 hdr_nid4->type = cpu_to_le32(hdr->type);
549 hdr_nid4->payload_length = cpu_to_le32(hdr->payload_length);
551 hdr_nid4->msg = hdr->msg;
554 static inline void lnet_hdr_from_nid16(struct lnet_hdr *hdr,
555 const struct lnet_hdr_nid16 *vhdr)
557 const struct lnet_hdr *hdr16 = (void *)vhdr;
559 hdr->dest_nid = hdr16->dest_nid;
560 hdr->src_nid = hdr16->src_nid;
561 hdr->dest_pid = le32_to_cpu(hdr16->dest_pid);
562 hdr->src_pid = le32_to_cpu(hdr16->src_pid);
563 hdr->type = le32_to_cpu(hdr16->type);
564 hdr->payload_length = le32_to_cpu(hdr16->payload_length);
567 static inline void lnet_hdr_to_nid16(const struct lnet_hdr *hdr,
568 struct lnet_hdr_nid16 *vhdr)
570 struct lnet_hdr *hdr16 = (void *)vhdr;
572 hdr16->dest_nid = hdr->dest_nid;
573 hdr16->src_nid = hdr->src_nid;
574 hdr16->dest_pid = cpu_to_le32(hdr->dest_pid);
575 hdr16->src_pid = cpu_to_le32(hdr->src_pid);
576 hdr16->type = cpu_to_le32(hdr->type);
577 hdr16->payload_length = cpu_to_le32(hdr->payload_length);
580 extern const struct lnet_lnd the_lolnd;
581 extern int avoid_asym_router_failure;
583 extern unsigned int lnet_nid_cpt_hash(struct lnet_nid *nid,
584 unsigned int number);
585 extern int lnet_cpt_of_nid_locked(struct lnet_nid *nid, struct lnet_ni *ni);
586 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
587 extern int lnet_nid2cpt(struct lnet_nid *nid, struct lnet_ni *ni);
588 extern struct lnet_ni *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
589 extern struct lnet_ni *lnet_nid_to_ni_locked(struct lnet_nid *nid, int cpt);
590 extern struct lnet_ni *lnet_nid2ni_addref(lnet_nid_t nid);
591 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
592 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
593 extern struct lnet_ni *lnet_nid_to_ni_addref(struct lnet_nid *nid);
594 struct lnet_net *lnet_get_net_locked(__u32 net_id);
596 int lnet_lib_init(void);
597 void lnet_lib_exit(void);
599 extern unsigned int lnet_response_tracking;
600 extern unsigned lnet_transaction_timeout;
601 extern unsigned lnet_retry_count;
602 extern unsigned int lnet_lnd_timeout;
603 extern unsigned int lnet_numa_range;
604 extern unsigned int lnet_health_sensitivity;
605 extern unsigned int lnet_recovery_interval;
606 extern unsigned int lnet_recovery_limit;
607 extern unsigned int lnet_peer_discovery_disabled;
608 extern unsigned int lnet_drop_asym_route;
609 extern unsigned int router_sensitivity_percentage;
610 extern int alive_router_check_interval;
611 extern int live_router_check_interval;
612 extern int dead_router_check_interval;
613 extern int portal_rotor;
615 void lnet_mt_event_handler(struct lnet_event *event);
617 int lnet_notify(struct lnet_ni *ni, lnet_nid_t peer, bool alive, bool reset,
619 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
621 int lnet_add_route(__u32 net, __u32 hops, struct lnet_nid *gateway,
622 __u32 priority, __u32 sensitivity);
623 int lnet_del_route(__u32 net, struct lnet_nid *gw_nid);
624 void lnet_move_route(struct lnet_route *route, struct lnet_peer *lp,
625 struct list_head *rt_list);
626 void lnet_destroy_routes(void);
627 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
628 lnet_nid_t *gateway, __u32 *alive, __u32 *priority,
630 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
631 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
632 struct lnet_ni *prev);
633 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
634 int lnet_get_net_healthv_locked(struct lnet_net *net);
636 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
637 struct libcfs_ioctl_hdr __user *uparam);
638 extern int lnet_get_peer_list(__u32 *countp, __u32 *sizep,
639 struct lnet_process_id __user *ids);
640 extern void lnet_peer_ni_set_healthv(lnet_nid_t nid, int value, bool all);
641 extern void lnet_peer_ni_add_to_recoveryq_locked(struct lnet_peer_ni *lpni,
642 struct list_head *queue,
644 extern int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni,
645 struct lnet_nid *nid);
646 extern void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
647 extern int lnet_peer_del_pref_nid(struct lnet_peer_ni *lpni,
648 struct lnet_nid *nid);
649 void lnet_peer_ni_set_selection_priority(struct lnet_peer_ni *lpni,
651 extern void lnet_ni_add_to_recoveryq_locked(struct lnet_ni *ni,
652 struct list_head *queue,
655 void lnet_router_debugfs_init(void);
656 void lnet_router_debugfs_fini(void);
657 int lnet_rtrpools_alloc(int im_a_router);
658 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
659 int lnet_rtrpools_adjust(int tiny, int small, int large);
660 int lnet_rtrpools_enable(void);
661 void lnet_rtrpools_disable(void);
662 void lnet_rtrpools_free(int keep_pools);
663 void lnet_rtr_transfer_to_peer(struct lnet_peer *src,
664 struct lnet_peer *target);
665 struct lnet_remotenet *lnet_find_rnet_locked(__u32 net);
666 int lnet_dyn_add_net(struct lnet_ioctl_config_data *conf);
667 int lnet_dyn_del_net(__u32 net);
668 int lnet_dyn_add_ni(struct lnet_ioctl_config_ni *conf);
669 int lnet_dyn_del_ni(struct lnet_ioctl_config_ni *conf);
670 int lnet_clear_lazy_portal(struct lnet_ni *ni, int portal, char *reason);
671 struct lnet_net *lnet_get_net_locked(__u32 net_id);
672 void lnet_net_clr_pref_rtrs(struct lnet_net *net);
673 int lnet_net_add_pref_rtr(struct lnet_net *net, struct lnet_nid *gw_nid);
675 int lnet_islocalnid(struct lnet_nid *nid);
676 int lnet_islocalnet(__u32 net);
677 int lnet_islocalnet_locked(__u32 net);
679 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
680 unsigned int offset, unsigned int mlen);
681 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
682 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
683 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
684 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
686 void lnet_prep_send(struct lnet_msg *msg, int type,
687 struct lnet_processid *target, unsigned int offset,
689 int lnet_send(struct lnet_nid *nid, struct lnet_msg *msg,
690 struct lnet_nid *rtr_nid);
691 int lnet_send_ping(struct lnet_nid *dest_nid, struct lnet_handle_md *mdh,
692 int nnis, void *user_ptr, lnet_handler_t handler,
694 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
695 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
696 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
697 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
699 struct list_head **lnet_create_array_of_queues(void);
701 /* portals functions */
702 /* portals attributes */
704 lnet_ptl_is_lazy(struct lnet_portal *ptl)
706 return !!(ptl->ptl_options & LNET_PTL_LAZY);
710 lnet_ptl_is_unique(struct lnet_portal *ptl)
712 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
716 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
718 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
722 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
724 ptl->ptl_options |= opt;
728 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
730 ptl->ptl_options &= ~opt;
733 /* match-table functions */
734 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
735 struct lnet_processid *id, __u64 mbits);
736 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
737 struct lnet_processid *id,
738 __u64 mbits, __u64 ignore_bits,
739 enum lnet_ins_pos pos);
740 int lnet_mt_match_md(struct lnet_match_table *mtable,
741 struct lnet_match_info *info, struct lnet_msg *msg);
743 /* portals match/attach functions */
744 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
745 struct list_head *matches, struct list_head *drops);
746 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
747 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
749 /* initialized and finalize portals */
750 int lnet_portals_create(void);
751 void lnet_portals_destroy(void);
753 /* message functions */
754 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
755 struct lnet_nid *fromnid, void *private, int rdma_req);
756 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
757 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
759 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
760 int delayed, unsigned int offset, unsigned int mlen,
762 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
763 int delayed, unsigned int offset,
764 unsigned int mlen, unsigned int rlen);
765 void lnet_ni_send(struct lnet_ni *ni, struct lnet_msg *msg);
767 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
768 struct lnet_msg *get_msg);
769 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
771 void lnet_detach_rsp_tracker(struct lnet_libmd *md, int cpt);
772 void lnet_clean_zombie_rstqs(void);
774 bool lnet_md_discarded(struct lnet_libmd *md);
775 void lnet_finalize(struct lnet_msg *msg, int rc);
776 bool lnet_send_error_simulation(struct lnet_msg *msg,
777 enum lnet_msg_hstatus *hstatus);
778 void lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni);
780 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
781 unsigned int nob, __u32 msg_type);
782 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
783 void lnet_recv_delayed_msg_list(struct list_head *head);
785 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
786 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
787 void lnet_msg_containers_destroy(void);
788 int lnet_msg_containers_create(void);
790 char *lnet_health_error2str(enum lnet_msg_hstatus hstatus);
791 char *lnet_msgtyp2str(int type);
792 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
794 /** \addtogroup lnet_fault_simulation @{ */
796 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
797 int lnet_fault_init(void);
798 void lnet_fault_fini(void);
800 bool lnet_drop_rule_match(struct lnet_hdr *hdr, struct lnet_nid *local_nid,
801 enum lnet_msg_hstatus *hstatus);
803 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
804 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
805 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
806 struct lnet_fault_stat *stat);
807 void lnet_delay_rule_reset(void);
808 void lnet_delay_rule_check(void);
809 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
811 /** @} lnet_fault_simulation */
813 void lnet_counters_get_common(struct lnet_counters_common *common);
814 int lnet_counters_get(struct lnet_counters *counters);
815 void lnet_counters_reset(void);
817 lnet_ni_set_sel_priority_locked(struct lnet_ni *ni, __u32 priority)
819 ni->ni_sel_priority = priority;
823 lnet_net_set_sel_priority_locked(struct lnet_net *net, __u32 priority)
825 net->net_sel_priority = priority;
828 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
829 unsigned int lnet_kiov_nob(unsigned int niov, struct bio_vec *iov);
830 int lnet_extract_kiov(int dst_niov, struct bio_vec *dst,
831 int src_niov, struct bio_vec *src,
832 unsigned int offset, unsigned int len);
834 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
835 unsigned int doffset,
836 unsigned int nsiov, struct kvec *siov,
837 unsigned int soffset, unsigned int nob);
838 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
839 unsigned int iovoffset,
840 unsigned int nkiov, struct bio_vec *kiov,
841 unsigned int kiovoffset, unsigned int nob);
842 void lnet_copy_iov2kiov(unsigned int nkiov, struct bio_vec *kiov,
843 unsigned int kiovoffset,
844 unsigned int niov, struct kvec *iov,
845 unsigned int iovoffset, unsigned int nob);
846 void lnet_copy_kiov2kiov(unsigned int ndkiov, struct bio_vec *dkiov,
847 unsigned int doffset,
848 unsigned int nskiov, struct bio_vec *skiov,
849 unsigned int soffset, unsigned int nob);
852 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
853 unsigned int nsiov, struct bio_vec *skiov,
854 unsigned int soffset, unsigned int nob)
856 struct kvec diov = { .iov_base = dest, .iov_len = dlen };
858 lnet_copy_kiov2iov(1, &diov, doffset,
859 nsiov, skiov, soffset, nob);
863 lnet_copy_flat2kiov(unsigned int ndiov, struct bio_vec *dkiov,
864 unsigned int doffset, int slen, void *src,
865 unsigned int soffset, unsigned int nob)
867 struct kvec siov = { .iov_base = src, .iov_len = slen };
868 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
869 1, &siov, soffset, nob);
872 void lnet_me_unlink(struct lnet_me *me);
874 void lnet_md_unlink(struct lnet_libmd *md);
875 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_event *ev);
876 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
877 struct page *lnet_get_first_page(struct lnet_libmd *md, unsigned int offset);
878 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
880 unsigned int lnet_get_lnd_timeout(void);
881 void lnet_register_lnd(const struct lnet_lnd *lnd);
882 void lnet_unregister_lnd(const struct lnet_lnd *lnd);
884 struct socket *lnet_connect(struct lnet_nid *peer_nid, int interface,
885 struct sockaddr *peeraddr, struct net *ns);
886 void lnet_connect_console_error(int rc, struct lnet_nid *peer_nid,
887 struct sockaddr *sa);
888 int lnet_count_acceptor_nets(void);
889 int lnet_acceptor_timeout(void);
890 int lnet_acceptor_port(void);
891 int lnet_acceptor_start(void);
892 void lnet_acceptor_stop(void);
894 struct lnet_inetdev {
899 char li_name[IFNAMSIZ];
902 int lnet_inet_enumerate(struct lnet_inetdev **dev_list, struct net *ns);
903 void lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
904 void lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
905 int lnet_sock_getaddr(struct socket *socket, bool remote,
906 struct sockaddr_storage *peer);
907 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
908 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
910 struct socket *lnet_sock_listen(int port, int backlog,
912 struct socket *lnet_sock_connect(int interface, int local_port,
913 struct sockaddr *peeraddr,
916 int lnet_peers_start_down(void);
917 int lnet_peer_buffer_credits(struct lnet_net *net);
918 void lnet_consolidate_routes_locked(struct lnet_peer *orig_lp,
919 struct lnet_peer *new_lp);
920 void lnet_router_discovery_complete(struct lnet_peer *lp);
921 void lnet_router_discovery_ping_reply(struct lnet_peer *lp);
923 int lnet_monitor_thr_start(void);
924 void lnet_monitor_thr_stop(void);
926 bool lnet_router_checker_active(void);
927 void lnet_check_routers(void);
928 void lnet_wait_router_start(void);
929 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
931 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
932 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int nnis, gfp_t gfp);
933 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
935 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
937 atomic_inc(&pbuf->pb_refcnt);
940 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
942 if (atomic_dec_and_test(&pbuf->pb_refcnt)) {
943 wake_up_var(&pbuf->pb_refcnt);
944 lnet_ping_buffer_free(pbuf);
948 static inline int lnet_push_target_resize_needed(void)
950 return the_lnet.ln_push_target->pb_nnis < the_lnet.ln_push_target_nnis;
953 int lnet_push_target_resize(void);
954 int lnet_push_target_post(struct lnet_ping_buffer *pbuf,
955 struct lnet_handle_md *mdh);
956 void lnet_peer_push_event(struct lnet_event *ev);
958 int lnet_parse_ip2nets(const char **networksp, const char *ip2nets);
959 int lnet_parse_routes(const char *route_str, int *im_a_router);
960 int lnet_parse_networks(struct list_head *nilist, const char *networks);
961 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
962 struct lnet_net **net);
963 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
964 void lnet_incr_dlc_seq(void);
965 __u32 lnet_get_dlc_seq_locked(void);
967 struct lnet_peer_net *lnet_get_next_peer_net_locked(struct lnet_peer *lp,
969 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
970 struct lnet_peer_net *peer_net,
971 struct lnet_peer_ni *prev);
972 struct lnet_peer_ni *lnet_nid2peerni_locked(lnet_nid_t nid, lnet_nid_t pref,
974 struct lnet_peer_ni *lnet_peerni_by_nid_locked(struct lnet_nid *nid,
975 struct lnet_nid *pref,
977 struct lnet_peer_ni *lnet_nid2peerni_ex(struct lnet_nid *nid, int cpt);
978 struct lnet_peer_ni *lnet_peer_get_ni_locked(struct lnet_peer *lp,
980 struct lnet_peer_ni *lnet_peer_ni_get_locked(struct lnet_peer *lp,
981 struct lnet_nid *nid);
982 struct lnet_peer_ni *lnet_find_peer_ni_locked(lnet_nid_t nid);
983 struct lnet_peer_ni *lnet_peer_ni_find_locked(struct lnet_nid *nid);
984 struct lnet_peer *lnet_find_peer4(lnet_nid_t nid);
985 struct lnet_peer *lnet_find_peer(struct lnet_nid *nid);
986 void lnet_peer_net_added(struct lnet_net *net);
987 void lnet_peer_primary_nid_locked(struct lnet_nid *nid,
988 struct lnet_nid *result);
989 int lnet_discover_peer_locked(struct lnet_peer_ni *lpni, int cpt, bool block);
990 void lnet_peer_queue_message(struct lnet_peer *lp, struct lnet_msg *msg);
991 int lnet_peer_discovery_start(void);
992 void lnet_peer_discovery_stop(void);
993 void lnet_push_update_to_peers(int force);
994 void lnet_peer_tables_cleanup(struct lnet_net *net);
995 void lnet_peer_uninit(void);
996 int lnet_peer_tables_create(void);
997 void lnet_debug_peer(lnet_nid_t nid);
998 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
1000 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni,
1001 struct lnet_nid *nid);
1002 int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, struct lnet_nid *nid);
1003 void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
1004 bool lnet_peer_is_pref_rtr_locked(struct lnet_peer_ni *lpni,
1005 struct lnet_nid *gw_nid);
1006 void lnet_peer_clr_pref_rtrs(struct lnet_peer_ni *lpni);
1007 int lnet_peer_add_pref_rtr(struct lnet_peer_ni *lpni, struct lnet_nid *nid);
1008 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni,
1009 struct lnet_nid *nid);
1010 int lnet_add_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid, bool mr, bool temp);
1011 int lnet_del_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid);
1012 int lnet_get_peer_info(struct lnet_ioctl_peer_cfg *cfg, void __user *bulk);
1013 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
1014 char alivness[LNET_MAX_STR_LEN],
1015 __u32 *cpt_iter, __u32 *refcount,
1016 __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
1017 __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
1018 __u32 *peer_tx_qnob);
1019 int lnet_get_peer_ni_hstats(struct lnet_ioctl_peer_ni_hstats *stats);
1022 lnet_peer_net_set_sel_priority_locked(struct lnet_peer_net *lpn, __u32 priority)
1024 lpn->lpn_sel_priority = priority;
1028 static inline struct lnet_peer_net *
1029 lnet_find_peer_net_locked(struct lnet_peer *peer, __u32 net_id)
1031 struct lnet_peer_net *peer_net;
1033 list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
1034 if (peer_net->lpn_net_id == net_id)
1042 lnet_peer_is_multi_rail(struct lnet_peer *lp)
1044 if (lp->lp_state & LNET_PEER_MULTI_RAIL)
1050 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
1052 if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
1058 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
1060 return nid_same(&lpni->lpni_nid,
1061 &lpni->lpni_peer_net->lpn_peer->lp_primary_nid);
1064 bool lnet_peer_is_uptodate(struct lnet_peer *lp);
1065 bool lnet_peer_is_uptodate_locked(struct lnet_peer *lp);
1066 bool lnet_is_discovery_disabled(struct lnet_peer *lp);
1067 bool lnet_is_discovery_disabled_locked(struct lnet_peer *lp);
1068 bool lnet_peer_gw_discovery(struct lnet_peer *lp);
1071 lnet_peer_needs_push(struct lnet_peer *lp)
1073 if (!(lp->lp_state & LNET_PEER_MULTI_RAIL))
1075 if (lp->lp_state & LNET_PEER_MARK_DELETED)
1077 if (lp->lp_state & LNET_PEER_FORCE_PUSH)
1079 if (lp->lp_state & LNET_PEER_NO_DISCOVERY)
1081 /* if discovery is not enabled then no need to push */
1082 if (lnet_peer_discovery_disabled)
1084 if (lp->lp_node_seqno < atomic_read(&the_lnet.ln_ping_target_seqno))
1089 #define LNET_RECOVERY_INTERVAL_MAX 900
1090 static inline unsigned int
1091 lnet_get_next_recovery_ping(unsigned int ping_count, time64_t now)
1093 unsigned int interval;
1095 /* 2^9 = 512, 2^10 = 1024 */
1097 interval = LNET_RECOVERY_INTERVAL_MAX;
1099 interval = 1 << ping_count;
1101 return now + interval;
1105 lnet_peer_ni_set_next_ping(struct lnet_peer_ni *lpni, time64_t now)
1107 lpni->lpni_next_ping =
1108 lnet_get_next_recovery_ping(lpni->lpni_ping_count, now);
1112 lnet_ni_set_next_ping(struct lnet_ni *ni, time64_t now)
1114 ni->ni_next_ping = lnet_get_next_recovery_ping(ni->ni_ping_count, now);
1118 * A peer NI is alive if it satisfies the following two conditions:
1119 * 1. peer NI health >= LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage
1120 * 2. the cached NI status received when we discover the peer is UP
1123 lnet_is_peer_ni_alive(struct lnet_peer_ni *lpni)
1125 bool halive = false;
1127 halive = (atomic_read(&lpni->lpni_healthv) >=
1128 (LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage / 100));
1130 return halive && lpni->lpni_ns_status == LNET_NI_STATUS_UP;
1134 lnet_update_peer_net_healthv(struct lnet_peer_ni *lpni)
1136 struct lnet_peer_net *lpn;
1137 int best_healthv = 0;
1139 lpn = lpni->lpni_peer_net;
1141 list_for_each_entry(lpni, &lpn->lpn_peer_nis, lpni_peer_nis) {
1142 int lpni_healthv = atomic_read(&lpni->lpni_healthv);
1143 if (best_healthv < lpni_healthv)
1144 best_healthv = lpni_healthv;
1147 lpn->lpn_healthv = best_healthv;
1151 lnet_set_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1153 if (atomic_read(&lpni->lpni_healthv) == value)
1155 atomic_set(&lpni->lpni_healthv, value);
1156 lnet_update_peer_net_healthv(lpni);
1160 lnet_atomic_add_unless_max(atomic_t *v, int a, int u)
1162 int c = atomic_read(v);
1175 old = atomic_cmpxchg(v, c, m);
1191 lnet_inc_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1193 /* only adjust the net health if the lpni health value changed */
1194 if (lnet_atomic_add_unless_max(&lpni->lpni_healthv, value,
1195 LNET_MAX_HEALTH_VALUE))
1196 lnet_update_peer_net_healthv(lpni);
1200 lnet_inc_healthv(atomic_t *healthv, int value)
1202 lnet_atomic_add_unless_max(healthv, value, LNET_MAX_HEALTH_VALUE);
1206 lnet_get_list_len(struct list_head *list)
1208 struct list_head *l;
1211 list_for_each(l, list)
1217 void lnet_incr_stats(struct lnet_element_stats *stats,
1218 enum lnet_msg_type msg_type,
1219 enum lnet_stats_type stats_type);
1221 __u32 lnet_sum_stats(struct lnet_element_stats *stats,
1222 enum lnet_stats_type stats_type);
1224 void lnet_usr_translate_stats(struct lnet_ioctl_element_msg_stats *msg_stats,
1225 struct lnet_element_stats *stats);
1228 lnet_set_route_aliveness(struct lnet_route *route, bool alive)
1230 bool old = atomic_xchg(&route->lr_alive, alive);
1233 CERROR("route to %s through %s has gone from %s to %s\n",
1234 libcfs_net2str(route->lr_net),
1235 libcfs_nidstr(&route->lr_gateway->lp_primary_nid),
1236 old ? "up" : "down",
1237 alive ? "up" : "down");