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 # if defined(__GNUC__) && __GNUC__ >= 7
114 # define fallthrough __attribute__((fallthrough)) /* fallthrough */
116 # define fallthrough do {} while (0) /* fallthrough */
120 int choose_ipv4_src(__u32 *ret,
121 int interface, __u32 dst_ipaddr, struct net *ns);
123 bool lnet_is_route_alive(struct lnet_route *route);
124 bool lnet_is_gateway_alive(struct lnet_peer *gw);
126 static inline int lnet_is_wire_handle_none(struct lnet_handle_wire *wh)
128 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
129 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
132 static inline int lnet_md_exhausted(struct lnet_libmd *md)
134 return (md->md_threshold == 0 ||
135 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
136 md->md_offset + md->md_max_size > md->md_length));
139 static inline int lnet_md_unlinkable(struct lnet_libmd *md)
141 /* Should unlink md when its refcount is 0 and either:
142 * - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
143 * in the latter case md may not be exhausted).
144 * - auto unlink is on and md is exhausted.
146 if (md->md_refcount != 0)
149 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
152 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
153 lnet_md_exhausted(md));
156 #define lnet_cpt_table() (the_lnet.ln_cpt_table)
157 #define lnet_cpt_current() cfs_cpt_current(the_lnet.ln_cpt_table, 1)
160 lnet_cpt_of_cookie(__u64 cookie)
162 unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
164 /* LNET_CPT_NUMBER doesn't have to be power2, which means we can
165 * get illegal cpt from it's invalid cookie */
166 return cpt < LNET_CPT_NUMBER ? cpt : cpt % LNET_CPT_NUMBER;
170 lnet_res_lock(int cpt)
172 cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
176 lnet_res_unlock(int cpt)
178 cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
182 lnet_res_lock_current(void)
184 int cpt = lnet_cpt_current();
191 lnet_net_lock(int cpt)
193 cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
197 lnet_net_unlock(int cpt)
199 cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
203 lnet_net_lock_current(void)
205 int cpt = lnet_cpt_current();
211 #define LNET_LOCK() lnet_net_lock(LNET_LOCK_EX)
212 #define LNET_UNLOCK() lnet_net_unlock(LNET_LOCK_EX)
214 #define lnet_ptl_lock(ptl) spin_lock(&(ptl)->ptl_lock)
215 #define lnet_ptl_unlock(ptl) spin_unlock(&(ptl)->ptl_lock)
216 #define lnet_ni_lock(ni) spin_lock(&(ni)->ni_lock)
217 #define lnet_ni_unlock(ni) spin_unlock(&(ni)->ni_lock)
219 #define MAX_PORTALS 64
221 #define LNET_SMALL_MD_SIZE offsetof(struct lnet_libmd, md_kiov[1])
222 extern struct kmem_cache *lnet_mes_cachep; /* MEs kmem_cache */
223 extern struct kmem_cache *lnet_small_mds_cachep; /* <= LNET_SMALL_MD_SIZE bytes
225 extern struct kmem_cache *lnet_udsp_cachep;
226 extern struct kmem_cache *lnet_rspt_cachep;
227 extern struct kmem_cache *lnet_msg_cachep;
230 lnet_ni_set_status_locked(struct lnet_ni *ni, __u32 status)
231 __must_hold(&ni->ni_lock)
235 if (ni->ni_status && *ni->ni_status != status) {
236 CDEBUG(D_NET, "ni %s status changed from %#x to %#x\n",
237 libcfs_nidstr(&ni->ni_nid),
238 *ni->ni_status, status);
239 *ni->ni_status = status;
246 static inline unsigned int
247 lnet_ni_get_status_locked(struct lnet_ni *ni)
248 __must_hold(&ni->ni_lock)
250 if (nid_is_lo0(&ni->ni_nid))
251 return LNET_NI_STATUS_UP;
252 else if (atomic_read(&ni->ni_fatal_error_on))
253 return LNET_NI_STATUS_DOWN;
254 else if (ni->ni_status)
255 return *ni->ni_status;
257 return LNET_NI_STATUS_UP;
261 lnet_ni_set_status(struct lnet_ni *ni, __u32 status)
266 update = lnet_ni_set_status_locked(ni, status);
272 static inline void lnet_md_wait_handling(struct lnet_libmd *md, int cpt)
274 wait_queue_head_t *wq = __var_waitqueue(md);
275 #if defined(HAVE_WAIT_BIT_QUEUE_ENTRY) || !defined(HAVE_WAIT_VAR_EVENT)
276 struct wait_bit_queue_entry entry;
277 wait_queue_entry_t *wqe = &entry.wq_entry;
279 struct wait_bit_queue entry;
280 wait_queue_entry_t *wqe = &entry.wait;
282 init_wait_var_entry(&entry, md, 0);
283 prepare_to_wait_event(wq, wqe, TASK_IDLE);
284 if (md->md_flags & LNET_MD_FLAG_HANDLING) {
285 /* Race with unlocked call to ->md_handler.
286 * It is safe to drop the res_lock here as the
287 * caller has only just claimed it.
289 lnet_res_unlock(cpt);
291 /* Cannot check md now, it might be freed. Caller
292 * must reclaim reference and check.
296 finish_wait(wq, wqe);
300 lnet_md_free(struct lnet_libmd *md)
304 LASSERTF(md->md_rspt_ptr == NULL, "md %p rsp %p\n", md, md->md_rspt_ptr);
306 size = offsetof(struct lnet_libmd, md_kiov[md->md_niov]);
308 if (size <= LNET_SMALL_MD_SIZE) {
309 LIBCFS_MEM_MSG(md, size, "slab-freed");
310 kmem_cache_free(lnet_small_mds_cachep, md);
312 LIBCFS_FREE(md, size);
316 struct lnet_libhandle *lnet_res_lh_lookup(struct lnet_res_container *rec,
318 void lnet_res_lh_initialize(struct lnet_res_container *rec,
319 struct lnet_libhandle *lh);
321 lnet_res_lh_invalidate(struct lnet_libhandle *lh)
323 /* ALWAYS called with resource lock held */
324 /* NB: cookie is still useful, don't reset it */
325 list_del(&lh->lh_hash_chain);
329 lnet_md2handle(struct lnet_handle_md *handle, struct lnet_libmd *md)
331 handle->cookie = md->md_lh.lh_cookie;
334 static inline struct lnet_libmd *
335 lnet_handle2md(struct lnet_handle_md *handle)
337 /* ALWAYS called with resource lock held */
338 struct lnet_libhandle *lh;
341 cpt = lnet_cpt_of_cookie(handle->cookie);
342 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
347 return lh_entry(lh, struct lnet_libmd, md_lh);
350 static inline struct lnet_libmd *
351 lnet_wire_handle2md(struct lnet_handle_wire *wh)
353 /* ALWAYS called with resource lock held */
354 struct lnet_libhandle *lh;
357 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
360 cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
361 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
362 wh->wh_object_cookie);
366 return lh_entry(lh, struct lnet_libmd, md_lh);
370 lnet_peer_net_addref_locked(struct lnet_peer_net *lpn)
372 atomic_inc(&lpn->lpn_refcount);
375 extern void lnet_destroy_peer_net_locked(struct lnet_peer_net *lpn);
378 lnet_peer_net_decref_locked(struct lnet_peer_net *lpn)
380 if (atomic_dec_and_test(&lpn->lpn_refcount))
381 lnet_destroy_peer_net_locked(lpn);
385 lnet_peer_addref_locked(struct lnet_peer *lp)
387 atomic_inc(&lp->lp_refcount);
390 extern void lnet_destroy_peer_locked(struct lnet_peer *lp);
393 lnet_peer_decref_locked(struct lnet_peer *lp)
395 if (atomic_dec_and_test(&lp->lp_refcount))
396 lnet_destroy_peer_locked(lp);
400 lnet_peer_ni_addref_locked(struct lnet_peer_ni *lp)
402 kref_get(&lp->lpni_kref);
405 extern void lnet_destroy_peer_ni_locked(struct kref *ref);
408 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
410 kref_put(&lp->lpni_kref, lnet_destroy_peer_ni_locked);
414 lnet_isrouter(struct lnet_peer_ni *lpni)
416 return lpni->lpni_peer_net->lpn_peer->lp_rtr_refcount != 0;
420 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
422 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
423 LASSERT(*ni->ni_refs[cpt] >= 0);
425 (*ni->ni_refs[cpt])++;
429 lnet_ni_addref(struct lnet_ni *ni)
432 lnet_ni_addref_locked(ni, 0);
437 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
439 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
440 LASSERT(*ni->ni_refs[cpt] > 0);
442 (*ni->ni_refs[cpt])--;
446 lnet_ni_decref(struct lnet_ni *ni)
449 lnet_ni_decref_locked(ni, 0);
453 static inline struct lnet_msg *
456 struct lnet_msg *msg;
458 msg = kmem_cache_zalloc(lnet_msg_cachep, GFP_NOFS);
464 lnet_msg_free(struct lnet_msg *msg)
466 LASSERT(!msg->msg_onactivelist);
467 kmem_cache_free(lnet_msg_cachep, msg);
470 static inline struct lnet_rsp_tracker *
471 lnet_rspt_alloc(int cpt)
473 struct lnet_rsp_tracker *rspt;
475 rspt = kmem_cache_zalloc(lnet_rspt_cachep, GFP_NOFS);
478 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc++;
479 lnet_net_unlock(cpt);
481 LIBCFS_ALLOC_POST(rspt, sizeof(*rspt), "alloc");
486 lnet_rspt_free(struct lnet_rsp_tracker *rspt, int cpt)
488 LIBCFS_FREE_PRE(rspt, sizeof(*rspt), "free");
489 kmem_cache_free(lnet_rspt_cachep, rspt);
491 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc--;
492 lnet_net_unlock(cpt);
495 void lnet_ni_free(struct lnet_ni *ni);
496 void lnet_net_free(struct lnet_net *net);
499 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
502 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
505 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
507 int lnet_ni_add_interface(struct lnet_ni *ni, char *iface);
510 lnet_nid2peerhash(struct lnet_nid *nid)
515 for (i = 0; i < 4; i++)
516 h = hash_32(nid->nid_addr[i]^h, 32);
517 return hash_32(LNET_NID_NET(nid) ^ h, LNET_PEER_HASH_BITS);
520 static inline struct list_head *
521 lnet_net2rnethash(__u32 net)
523 return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
525 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
528 static inline void lnet_hdr_from_nid4(struct lnet_hdr *hdr,
529 const struct lnet_hdr_nid4 *vhdr)
531 const struct _lnet_hdr_nid4 *hdr_nid4 = (void *)vhdr;
533 lnet_nid4_to_nid(le64_to_cpu(hdr_nid4->dest_nid), &hdr->dest_nid);
534 lnet_nid4_to_nid(le64_to_cpu(hdr_nid4->src_nid), &hdr->src_nid);
535 hdr->dest_pid = le32_to_cpu(hdr_nid4->dest_pid);
536 hdr->src_pid = le32_to_cpu(hdr_nid4->src_pid);
537 hdr->type = le32_to_cpu(hdr_nid4->type);
538 hdr->payload_length = le32_to_cpu(hdr_nid4->payload_length);
540 hdr->msg = hdr_nid4->msg;
543 static inline void lnet_hdr_to_nid4(const struct lnet_hdr *hdr,
544 struct lnet_hdr_nid4 *vhdr)
546 struct _lnet_hdr_nid4 *hdr_nid4 = (void *)vhdr;
548 hdr_nid4->dest_nid = cpu_to_le64(lnet_nid_to_nid4(&hdr->dest_nid));
549 hdr_nid4->src_nid = cpu_to_le64(lnet_nid_to_nid4(&hdr->src_nid));
550 hdr_nid4->dest_pid = cpu_to_le32(hdr->dest_pid);
551 hdr_nid4->src_pid = cpu_to_le32(hdr->src_pid);
552 hdr_nid4->type = cpu_to_le32(hdr->type);
553 hdr_nid4->payload_length = cpu_to_le32(hdr->payload_length);
555 hdr_nid4->msg = hdr->msg;
558 static inline void lnet_hdr_from_nid16(struct lnet_hdr *hdr,
559 const struct lnet_hdr_nid16 *vhdr)
561 const struct lnet_hdr *hdr16 = (void *)vhdr;
563 hdr->dest_nid = hdr16->dest_nid;
564 hdr->src_nid = hdr16->src_nid;
565 hdr->dest_pid = le32_to_cpu(hdr16->dest_pid);
566 hdr->src_pid = le32_to_cpu(hdr16->src_pid);
567 hdr->type = le32_to_cpu(hdr16->type);
568 hdr->payload_length = le32_to_cpu(hdr16->payload_length);
571 static inline void lnet_hdr_to_nid16(const struct lnet_hdr *hdr,
572 struct lnet_hdr_nid16 *vhdr)
574 struct lnet_hdr *hdr16 = (void *)vhdr;
576 hdr16->dest_nid = hdr->dest_nid;
577 hdr16->src_nid = hdr->src_nid;
578 hdr16->dest_pid = cpu_to_le32(hdr->dest_pid);
579 hdr16->src_pid = cpu_to_le32(hdr->src_pid);
580 hdr16->type = cpu_to_le32(hdr->type);
581 hdr16->payload_length = cpu_to_le32(hdr->payload_length);
584 extern const struct lnet_lnd the_lolnd;
585 extern int avoid_asym_router_failure;
587 extern unsigned int lnet_nid_cpt_hash(struct lnet_nid *nid,
588 unsigned int number);
589 extern int lnet_cpt_of_nid_locked(struct lnet_nid *nid, struct lnet_ni *ni);
590 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
591 extern int lnet_nid2cpt(struct lnet_nid *nid, struct lnet_ni *ni);
592 extern struct lnet_ni *lnet_nid_to_ni_locked(struct lnet_nid *nid, int cpt);
593 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
594 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
595 extern struct lnet_ni *lnet_nid_to_ni_addref(struct lnet_nid *nid);
596 struct lnet_net *lnet_get_net_locked(__u32 net_id);
598 int lnet_lib_init(void);
599 void lnet_lib_exit(void);
600 void lnet_router_exit(void);
602 extern unsigned int lnet_response_tracking;
603 extern unsigned lnet_transaction_timeout;
604 extern unsigned lnet_retry_count;
605 extern unsigned int lnet_lnd_timeout;
606 extern unsigned int lnet_numa_range;
607 extern unsigned int lnet_health_sensitivity;
608 extern unsigned int lnet_recovery_interval;
609 extern unsigned int lnet_recovery_limit;
610 extern unsigned int lnet_peer_discovery_disabled;
611 extern unsigned int lnet_drop_asym_route;
612 extern unsigned int lnet_max_recovery_ping_interval;
613 extern unsigned int lnet_max_recovery_ping_count;
614 extern unsigned int router_sensitivity_percentage;
615 extern int alive_router_check_interval;
616 extern int live_router_check_interval;
617 extern int dead_router_check_interval;
618 extern int portal_rotor;
620 void lnet_mt_event_handler(struct lnet_event *event);
622 int lnet_notify(struct lnet_ni *ni, struct lnet_nid *peer, bool alive,
623 bool reset, time64_t when);
624 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
626 int lnet_add_route(__u32 net, __u32 hops, struct lnet_nid *gateway,
627 __u32 priority, __u32 sensitivity);
628 int lnet_del_route(__u32 net, struct lnet_nid *gw_nid);
629 void lnet_move_route(struct lnet_route *route, struct lnet_peer *lp,
630 struct list_head *rt_list);
631 void lnet_destroy_routes(void);
632 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
633 lnet_nid_t *gateway, __u32 *alive, __u32 *priority,
635 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
636 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
637 struct lnet_ni *prev);
638 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
639 int lnet_get_net_healthv_locked(struct lnet_net *net);
641 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
642 struct libcfs_ioctl_hdr __user *uparam);
643 extern int lnet_get_peer_list(__u32 *countp, __u32 *sizep,
644 struct lnet_process_id __user *ids);
645 extern void lnet_peer_ni_set_healthv(lnet_nid_t nid, int value, bool all);
646 extern void lnet_peer_ni_add_to_recoveryq_locked(struct lnet_peer_ni *lpni,
647 struct list_head *queue,
649 extern int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni,
650 struct lnet_nid *nid);
651 extern void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
652 extern int lnet_peer_del_pref_nid(struct lnet_peer_ni *lpni,
653 struct lnet_nid *nid);
654 void lnet_peer_ni_set_selection_priority(struct lnet_peer_ni *lpni,
656 extern void lnet_ni_add_to_recoveryq_locked(struct lnet_ni *ni,
657 struct list_head *queue,
660 void lnet_router_debugfs_init(void);
661 void lnet_router_debugfs_fini(void);
662 int lnet_rtrpools_alloc(int im_a_router);
663 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
664 int lnet_rtrpools_adjust(int tiny, int small, int large);
665 int lnet_rtrpools_enable(void);
666 void lnet_rtrpools_disable(void);
667 void lnet_rtrpools_free(int keep_pools);
668 void lnet_rtr_transfer_to_peer(struct lnet_peer *src,
669 struct lnet_peer *target);
670 struct lnet_remotenet *lnet_find_rnet_locked(__u32 net);
671 int lnet_dyn_add_net(struct lnet_ioctl_config_data *conf);
672 int lnet_dyn_del_net(__u32 net);
673 int lnet_dyn_add_ni(struct lnet_ioctl_config_ni *conf, u32 net,
674 struct lnet_ioctl_config_lnd_tunables *tun);
675 int lnet_dyn_del_ni(struct lnet_nid *nid);
676 int lnet_clear_lazy_portal(struct lnet_ni *ni, int portal, char *reason);
677 struct lnet_net *lnet_get_net_locked(__u32 net_id);
678 void lnet_net_clr_pref_rtrs(struct lnet_net *net);
679 int lnet_net_add_pref_rtr(struct lnet_net *net, struct lnet_nid *gw_nid);
681 int lnet_islocalnid(struct lnet_nid *nid);
682 int lnet_islocalnet(__u32 net);
683 int lnet_islocalnet_locked(__u32 net);
685 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
686 unsigned int offset, unsigned int mlen);
687 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
688 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
689 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
690 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
692 void lnet_prep_send(struct lnet_msg *msg, int type,
693 struct lnet_processid *target, unsigned int offset,
695 int lnet_send(struct lnet_nid *nid, struct lnet_msg *msg,
696 struct lnet_nid *rtr_nid);
697 int lnet_send_ping(struct lnet_nid *dest_nid, struct lnet_handle_md *mdh,
698 int bytes, void *user_ptr, lnet_handler_t handler,
700 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
701 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
702 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
703 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
705 struct list_head **lnet_create_array_of_queues(void);
707 /* portals functions */
708 /* portals attributes */
710 lnet_ptl_is_lazy(struct lnet_portal *ptl)
712 return !!(ptl->ptl_options & LNET_PTL_LAZY);
716 lnet_ptl_is_unique(struct lnet_portal *ptl)
718 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
722 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
724 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
728 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
730 ptl->ptl_options |= opt;
734 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
736 ptl->ptl_options &= ~opt;
739 /* match-table functions */
740 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
741 struct lnet_processid *id, __u64 mbits);
742 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
743 struct lnet_processid *id,
744 __u64 mbits, __u64 ignore_bits,
745 enum lnet_ins_pos pos);
746 int lnet_mt_match_md(struct lnet_match_table *mtable,
747 struct lnet_match_info *info, struct lnet_msg *msg);
749 /* portals match/attach functions */
750 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
751 struct list_head *matches, struct list_head *drops);
752 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
753 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
755 /* initialized and finalize portals */
756 int lnet_portals_create(void);
757 void lnet_portals_destroy(void);
759 /* message functions */
760 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
761 struct lnet_nid *fromnid, void *private, int rdma_req);
762 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
763 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
765 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
766 int delayed, unsigned int offset, unsigned int mlen,
768 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
769 int delayed, unsigned int offset,
770 unsigned int mlen, unsigned int rlen);
771 void lnet_ni_send(struct lnet_ni *ni, struct lnet_msg *msg);
773 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
774 struct lnet_msg *get_msg);
775 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
777 void lnet_detach_rsp_tracker(struct lnet_libmd *md, int cpt);
778 void lnet_clean_zombie_rstqs(void);
780 bool lnet_md_discarded(struct lnet_libmd *md);
781 void lnet_finalize(struct lnet_msg *msg, int rc);
782 bool lnet_send_error_simulation(struct lnet_msg *msg,
783 enum lnet_msg_hstatus *hstatus);
784 void lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni);
786 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
787 unsigned int nob, __u32 msg_type);
788 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
789 void lnet_recv_delayed_msg_list(struct list_head *head);
791 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
792 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
793 void lnet_msg_containers_destroy(void);
794 int lnet_msg_containers_create(void);
796 char *lnet_health_error2str(enum lnet_msg_hstatus hstatus);
797 char *lnet_msgtyp2str(int type);
798 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
800 /** \addtogroup lnet_fault_simulation @{ */
802 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
803 int lnet_fault_init(void);
804 void lnet_fault_fini(void);
806 bool lnet_drop_rule_match(struct lnet_hdr *hdr, struct lnet_nid *local_nid,
807 enum lnet_msg_hstatus *hstatus);
809 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
810 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
811 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
812 struct lnet_fault_stat *stat);
813 void lnet_delay_rule_reset(void);
814 void lnet_delay_rule_check(void);
815 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
817 /** @} lnet_fault_simulation */
819 void lnet_counters_get_common(struct lnet_counters_common *common);
820 int lnet_counters_get(struct lnet_counters *counters);
821 void lnet_counters_reset(void);
823 lnet_ni_set_sel_priority_locked(struct lnet_ni *ni, __u32 priority)
825 ni->ni_sel_priority = priority;
829 lnet_net_set_sel_priority_locked(struct lnet_net *net, __u32 priority)
831 net->net_sel_priority = priority;
834 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
835 unsigned int lnet_kiov_nob(unsigned int niov, struct bio_vec *iov);
836 int lnet_extract_kiov(int dst_niov, struct bio_vec *dst,
837 int src_niov, struct bio_vec *src,
838 unsigned int offset, unsigned int len);
840 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
841 unsigned int doffset,
842 unsigned int nsiov, struct kvec *siov,
843 unsigned int soffset, unsigned int nob);
844 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
845 unsigned int iovoffset,
846 unsigned int nkiov, struct bio_vec *kiov,
847 unsigned int kiovoffset, unsigned int nob);
848 void lnet_copy_iov2kiov(unsigned int nkiov, struct bio_vec *kiov,
849 unsigned int kiovoffset,
850 unsigned int niov, struct kvec *iov,
851 unsigned int iovoffset, unsigned int nob);
852 void lnet_copy_kiov2kiov(unsigned int ndkiov, struct bio_vec *dkiov,
853 unsigned int doffset,
854 unsigned int nskiov, struct bio_vec *skiov,
855 unsigned int soffset, unsigned int nob);
858 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
859 unsigned int nsiov, struct bio_vec *skiov,
860 unsigned int soffset, unsigned int nob)
862 struct kvec diov = { .iov_base = dest, .iov_len = dlen };
864 lnet_copy_kiov2iov(1, &diov, doffset,
865 nsiov, skiov, soffset, nob);
869 lnet_copy_flat2kiov(unsigned int ndiov, struct bio_vec *dkiov,
870 unsigned int doffset, int slen, void *src,
871 unsigned int soffset, unsigned int nob)
873 struct kvec siov = { .iov_base = src, .iov_len = slen };
874 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
875 1, &siov, soffset, nob);
878 void lnet_me_unlink(struct lnet_me *me);
880 void lnet_md_unlink(struct lnet_libmd *md);
881 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_event *ev);
882 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
883 struct page *lnet_get_first_page(struct lnet_libmd *md, unsigned int offset);
884 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
886 unsigned int lnet_get_lnd_timeout(void);
887 void lnet_register_lnd(const struct lnet_lnd *lnd);
888 void lnet_unregister_lnd(const struct lnet_lnd *lnd);
890 struct socket *lnet_connect(struct lnet_nid *peer_nid, int interface,
891 struct sockaddr *peeraddr, struct net *ns);
892 void lnet_connect_console_error(int rc, struct lnet_nid *peer_nid,
893 struct sockaddr *sa);
894 int lnet_count_acceptor_nets(void);
895 int lnet_acceptor_timeout(void);
896 int lnet_acceptor_port(void);
897 int lnet_acceptor_start(void);
898 void lnet_acceptor_stop(void);
900 struct lnet_inetdev {
912 char li_name[IFNAMSIZ];
915 int lnet_inet_enumerate(struct lnet_inetdev **dev_list, struct net *ns,
917 void lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
918 void lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
919 int lnet_sock_getaddr(struct socket *socket, bool remote,
920 struct sockaddr_storage *peer);
921 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
922 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
924 struct socket *lnet_sock_listen(int port, int backlog,
926 struct socket *lnet_sock_connect(int interface, int local_port,
927 struct sockaddr *peeraddr,
930 int lnet_peers_start_down(void);
931 int lnet_peer_buffer_credits(struct lnet_net *net);
932 void lnet_consolidate_routes_locked(struct lnet_peer *orig_lp,
933 struct lnet_peer *new_lp);
934 void lnet_router_discovery_complete(struct lnet_peer *lp);
935 void lnet_router_discovery_ping_reply(struct lnet_peer *lp,
936 struct lnet_ping_buffer *pbuf);
938 int lnet_monitor_thr_start(void);
939 void lnet_monitor_thr_stop(void);
941 bool lnet_router_checker_active(void);
942 void lnet_check_routers(void);
943 void lnet_wait_router_start(void);
944 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
946 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
947 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int bytes, gfp_t gfp);
948 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
950 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
952 atomic_inc(&pbuf->pb_refcnt);
955 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
957 if (atomic_dec_and_test(&pbuf->pb_refcnt)) {
958 wake_up_var(&pbuf->pb_refcnt);
959 lnet_ping_buffer_free(pbuf);
963 struct lnet_ping_iter {
964 struct lnet_ping_info *pinfo;
968 u32 *ping_iter_first(struct lnet_ping_iter *pi, struct lnet_ping_buffer *pbuf,
969 struct lnet_nid *nid);
970 u32 *ping_iter_next(struct lnet_ping_iter *pi, struct lnet_nid *nid);
972 static inline int lnet_push_target_resize_needed(void)
974 return the_lnet.ln_push_target->pb_nbytes < the_lnet.ln_push_target_nbytes;
977 int lnet_push_target_resize(void);
978 int lnet_push_target_post(struct lnet_ping_buffer *pbuf,
979 struct lnet_handle_md *mdh);
980 void lnet_peer_push_event(struct lnet_event *ev);
982 int lnet_parse_ip2nets(const char **networksp, const char *ip2nets);
983 int lnet_parse_routes(const char *route_str, int *im_a_router);
984 int lnet_parse_networks(struct list_head *nilist, const char *networks);
985 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
986 struct lnet_net **net);
987 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
988 void lnet_incr_dlc_seq(void);
989 __u32 lnet_get_dlc_seq_locked(void);
991 struct lnet_peer_net *lnet_get_next_peer_net_locked(struct lnet_peer *lp,
993 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
994 struct lnet_peer_net *peer_net,
995 struct lnet_peer_ni *prev);
996 struct lnet_peer_ni *lnet_peerni_by_nid_locked(struct lnet_nid *nid,
997 struct lnet_nid *pref,
999 struct lnet_peer_ni *lnet_nid2peerni_ex(struct lnet_nid *nid);
1000 struct lnet_peer_ni *lnet_peer_ni_get_locked(struct lnet_peer *lp,
1001 struct lnet_nid *nid);
1002 struct lnet_peer_ni *lnet_peer_ni_find_locked(struct lnet_nid *nid);
1003 struct lnet_peer *lnet_find_peer(struct lnet_nid *nid);
1004 void lnet_peer_net_added(struct lnet_net *net);
1005 void lnet_peer_primary_nid_locked(struct lnet_nid *nid,
1006 struct lnet_nid *result);
1007 int lnet_discover_peer_locked(struct lnet_peer_ni *lpni, int cpt, bool block);
1008 void lnet_peer_queue_message(struct lnet_peer *lp, struct lnet_msg *msg);
1009 int lnet_peer_discovery_start(void);
1010 void lnet_peer_discovery_stop(void);
1011 void lnet_push_update_to_peers(int force);
1012 void lnet_peer_tables_cleanup(struct lnet_net *net);
1013 void lnet_peer_uninit(void);
1014 int lnet_peer_tables_create(void);
1015 void lnet_debug_peer(struct lnet_nid *nid);
1016 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
1018 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni,
1019 struct lnet_nid *nid);
1020 int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, struct lnet_nid *nid);
1021 void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
1022 bool lnet_peer_is_pref_rtr_locked(struct lnet_peer_ni *lpni,
1023 struct lnet_nid *gw_nid);
1024 void lnet_peer_clr_pref_rtrs(struct lnet_peer_ni *lpni);
1025 int lnet_peer_add_pref_rtr(struct lnet_peer_ni *lpni, struct lnet_nid *nid);
1026 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni,
1027 struct lnet_nid *nid);
1028 int lnet_add_peer_ni(struct lnet_nid *key_nid, struct lnet_nid *nid, bool mr,
1030 int lnet_del_peer_ni(struct lnet_nid *key_nid, struct lnet_nid *nid);
1031 int lnet_get_peer_info(struct lnet_ioctl_peer_cfg *cfg, void __user *bulk);
1032 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
1033 char alivness[LNET_MAX_STR_LEN],
1034 __u32 *cpt_iter, __u32 *refcount,
1035 __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
1036 __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
1037 __u32 *peer_tx_qnob);
1038 int lnet_get_peer_ni_hstats(struct lnet_ioctl_peer_ni_hstats *stats);
1041 lnet_peer_net_set_sel_priority_locked(struct lnet_peer_net *lpn, __u32 priority)
1043 lpn->lpn_sel_priority = priority;
1047 static inline struct lnet_peer_net *
1048 lnet_find_peer_net_locked(struct lnet_peer *peer, __u32 net_id)
1050 struct lnet_peer_net *peer_net;
1052 list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
1053 if (peer_net->lpn_net_id == net_id)
1061 lnet_peer_is_multi_rail(struct lnet_peer *lp)
1063 if (lp->lp_state & LNET_PEER_MULTI_RAIL)
1069 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
1071 if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
1077 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
1079 return nid_same(&lpni->lpni_nid,
1080 &lpni->lpni_peer_net->lpn_peer->lp_primary_nid);
1083 bool lnet_peer_is_uptodate(struct lnet_peer *lp);
1084 bool lnet_peer_is_uptodate_locked(struct lnet_peer *lp);
1085 bool lnet_is_discovery_disabled(struct lnet_peer *lp);
1086 bool lnet_is_discovery_disabled_locked(struct lnet_peer *lp);
1087 bool lnet_peer_gw_discovery(struct lnet_peer *lp);
1090 lnet_peer_needs_push(struct lnet_peer *lp)
1092 if (!(lp->lp_state & LNET_PEER_MULTI_RAIL))
1094 if (lp->lp_state & LNET_PEER_MARK_DELETED)
1096 if (lp->lp_state & LNET_PEER_FORCE_PUSH)
1098 if (lp->lp_state & LNET_PEER_NO_DISCOVERY)
1100 /* if discovery is not enabled then no need to push */
1101 if (lnet_peer_discovery_disabled)
1103 if (lp->lp_node_seqno < atomic_read(&the_lnet.ln_ping_target_seqno))
1108 static inline unsigned int
1109 lnet_get_next_recovery_ping(unsigned int ping_count, time64_t now)
1111 unsigned int interval;
1113 /* lnet_max_recovery_interval <= 2^lnet_max_recovery_ping_count */
1114 if (ping_count > lnet_max_recovery_ping_count)
1115 interval = lnet_max_recovery_ping_interval;
1117 interval = 1 << ping_count;
1119 return now + interval;
1123 lnet_peer_ni_set_next_ping(struct lnet_peer_ni *lpni, time64_t now)
1125 lpni->lpni_next_ping =
1126 lnet_get_next_recovery_ping(lpni->lpni_ping_count, now);
1130 lnet_ni_set_next_ping(struct lnet_ni *ni, time64_t now)
1132 ni->ni_next_ping = lnet_get_next_recovery_ping(ni->ni_ping_count, now);
1136 * A peer NI is alive if it satisfies the following two conditions:
1137 * 1. peer NI health >= LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage
1138 * 2. the cached NI status received when we discover the peer is UP
1141 lnet_is_peer_ni_alive(struct lnet_peer_ni *lpni)
1143 bool halive = false;
1145 halive = (atomic_read(&lpni->lpni_healthv) >=
1146 (LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage / 100));
1148 return halive && lpni->lpni_ns_status == LNET_NI_STATUS_UP;
1152 lnet_update_peer_net_healthv(struct lnet_peer_ni *lpni)
1154 struct lnet_peer_net *lpn;
1155 int best_healthv = 0;
1157 lpn = lpni->lpni_peer_net;
1159 list_for_each_entry(lpni, &lpn->lpn_peer_nis, lpni_peer_nis) {
1160 int lpni_healthv = atomic_read(&lpni->lpni_healthv);
1161 if (best_healthv < lpni_healthv)
1162 best_healthv = lpni_healthv;
1165 lpn->lpn_healthv = best_healthv;
1169 lnet_set_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1171 if (atomic_read(&lpni->lpni_healthv) == value)
1173 atomic_set(&lpni->lpni_healthv, value);
1174 lnet_update_peer_net_healthv(lpni);
1178 lnet_atomic_add_unless_max(atomic_t *v, int a, int u)
1180 int c = atomic_read(v);
1193 old = atomic_cmpxchg(v, c, m);
1209 lnet_dec_healthv_locked(atomic_t *healthv, int sensitivity)
1211 int h = atomic_read(healthv);
1216 if (h < sensitivity)
1221 return (atomic_xchg(healthv, h) != h);
1225 lnet_dec_lpni_healthv_locked(struct lnet_peer_ni *lpni)
1227 /* If there is a health sensitivity in the peer then use that
1228 * instead of the globally set one.
1229 * only adjust the net health if the lpni health value changed
1231 if (lnet_dec_healthv_locked(&lpni->lpni_healthv,
1232 lpni->lpni_peer_net->lpn_peer->lp_health_sensitivity ? :
1233 lnet_health_sensitivity)) {
1234 lnet_update_peer_net_healthv(lpni);
1239 lnet_inc_lpni_healthv_locked(struct lnet_peer_ni *lpni)
1241 /* If there is a health sensitivity in the peer then use that
1242 * instead of the globally set one.
1243 * only adjust the net health if the lpni health value changed
1245 if (lnet_atomic_add_unless_max(&lpni->lpni_healthv,
1246 lpni->lpni_peer_net->lpn_peer->lp_health_sensitivity ? :
1247 lnet_health_sensitivity,
1248 LNET_MAX_HEALTH_VALUE)) {
1249 lnet_update_peer_net_healthv(lpni);
1254 lnet_inc_healthv(atomic_t *healthv, int value)
1256 lnet_atomic_add_unless_max(healthv, value, LNET_MAX_HEALTH_VALUE);
1260 lnet_get_list_len(struct list_head *list)
1262 struct list_head *l;
1265 list_for_each(l, list)
1271 void lnet_incr_stats(struct lnet_element_stats *stats,
1272 enum lnet_msg_type msg_type,
1273 enum lnet_stats_type stats_type);
1275 __u32 lnet_sum_stats(struct lnet_element_stats *stats,
1276 enum lnet_stats_type stats_type);
1278 void lnet_usr_translate_stats(struct lnet_ioctl_element_msg_stats *msg_stats,
1279 struct lnet_element_stats *stats);
1282 lnet_set_route_aliveness(struct lnet_route *route, bool alive)
1284 bool old = atomic_xchg(&route->lr_alive, alive);
1287 CERROR("route to %s through %s has gone from %s to %s\n",
1288 libcfs_net2str(route->lr_net),
1289 libcfs_nidstr(&route->lr_gateway->lp_primary_nid),
1290 old ? "up" : "down",
1291 alive ? "up" : "down");