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 /* need both kernel and user-land acceptor */
77 #define LNET_ACCEPTOR_MIN_RESERVED_PORT 512
78 #define LNET_ACCEPTOR_MAX_RESERVED_PORT 1023
80 /* default timeout and credits */
81 #define DEFAULT_PEER_TIMEOUT 180
82 #define DEFAULT_PEER_CREDITS 8
83 #define DEFAULT_CREDITS 256
85 /* default number of connections per peer */
86 #define DEFAULT_CONNS_PER_PEER 0
88 #ifdef HAVE_KERN_SOCK_GETNAME_2ARGS
89 #define lnet_kernel_getpeername(sock, addr, addrlen) \
90 kernel_getpeername(sock, addr)
91 #define lnet_kernel_getsockname(sock, addr, addrlen) \
92 kernel_getsockname(sock, addr)
94 #define lnet_kernel_getpeername(sock, addr, addrlen) \
95 kernel_getpeername(sock, addr, addrlen)
96 #define lnet_kernel_getsockname(sock, addr, addrlen) \
97 kernel_getsockname(sock, addr, addrlen)
101 * kernel 5.3: commit ef11db3310e272d3d8dbe8739e0770820dd20e52
102 * kernel 4.18.0-193.el8:
103 * added in_dev_for_each_ifa_rtnl and in_dev_for_each_ifa_rcu
104 * and removed for_ifa and endfor_ifa.
105 * Use the _rntl variant as the current locking is rtnl.
107 #ifdef HAVE_IN_DEV_FOR_EACH_IFA_RTNL
108 #define DECLARE_CONST_IN_IFADDR(ifa) const struct in_ifaddr *ifa
109 #define endfor_ifa(in_dev)
111 #define DECLARE_CONST_IN_IFADDR(ifa)
112 #define in_dev_for_each_ifa_rtnl(ifa, in_dev) for_ifa((in_dev))
113 #define in_dev_for_each_ifa_rcu(ifa, in_dev) for_ifa((in_dev))
117 # if defined(__GNUC__) && __GNUC__ >= 7
118 # define fallthrough __attribute__((fallthrough)) /* fallthrough */
120 # define fallthrough do {} while (0) /* fallthrough */
124 int choose_ipv4_src(__u32 *ret,
125 int interface, __u32 dst_ipaddr, struct net *ns);
127 bool lnet_is_route_alive(struct lnet_route *route);
128 bool lnet_is_gateway_alive(struct lnet_peer *gw);
130 static inline int lnet_is_wire_handle_none(struct lnet_handle_wire *wh)
132 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
133 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
136 static inline int lnet_md_exhausted(struct lnet_libmd *md)
138 return (md->md_threshold == 0 ||
139 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
140 md->md_offset + md->md_max_size > md->md_length));
143 static inline int lnet_md_unlinkable(struct lnet_libmd *md)
145 /* Should unlink md when its refcount is 0 and either:
146 * - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
147 * in the latter case md may not be exhausted).
148 * - auto unlink is on and md is exhausted.
150 if (md->md_refcount != 0)
153 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
156 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
157 lnet_md_exhausted(md));
160 #define lnet_cpt_table() (the_lnet.ln_cpt_table)
161 #define lnet_cpt_current() cfs_cpt_current(the_lnet.ln_cpt_table, 1)
164 lnet_cpt_of_cookie(__u64 cookie)
166 unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
168 /* LNET_CPT_NUMBER doesn't have to be power2, which means we can
169 * get illegal cpt from it's invalid cookie */
170 return cpt < LNET_CPT_NUMBER ? cpt : cpt % LNET_CPT_NUMBER;
174 lnet_res_lock(int cpt)
176 cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
180 lnet_res_unlock(int cpt)
182 cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
186 lnet_res_lock_current(void)
188 int cpt = lnet_cpt_current();
195 lnet_net_lock(int cpt)
197 cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
201 lnet_net_unlock(int cpt)
203 cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
207 lnet_net_lock_current(void)
209 int cpt = lnet_cpt_current();
215 #define LNET_LOCK() lnet_net_lock(LNET_LOCK_EX)
216 #define LNET_UNLOCK() lnet_net_unlock(LNET_LOCK_EX)
218 #define lnet_ptl_lock(ptl) spin_lock(&(ptl)->ptl_lock)
219 #define lnet_ptl_unlock(ptl) spin_unlock(&(ptl)->ptl_lock)
220 #define lnet_ni_lock(ni) spin_lock(&(ni)->ni_lock)
221 #define lnet_ni_unlock(ni) spin_unlock(&(ni)->ni_lock)
223 #define MAX_PORTALS 64
225 #define LNET_SMALL_MD_SIZE offsetof(struct lnet_libmd, md_kiov[1])
226 extern struct kmem_cache *lnet_mes_cachep; /* MEs kmem_cache */
227 extern struct kmem_cache *lnet_small_mds_cachep; /* <= LNET_SMALL_MD_SIZE bytes
229 extern struct kmem_cache *lnet_udsp_cachep;
230 extern struct kmem_cache *lnet_rspt_cachep;
231 extern struct kmem_cache *lnet_msg_cachep;
234 lnet_ni_set_status_locked(struct lnet_ni *ni, __u32 status)
235 __must_hold(&ni->ni_lock)
239 if (ni->ni_status && *ni->ni_status != status) {
240 CDEBUG(D_NET, "ni %s status changed from %#x to %#x\n",
241 libcfs_nidstr(&ni->ni_nid),
242 *ni->ni_status, status);
243 *ni->ni_status = status;
250 static inline unsigned int
251 lnet_ni_get_status_locked(struct lnet_ni *ni)
252 __must_hold(&ni->ni_lock)
254 if (nid_is_lo0(&ni->ni_nid))
255 return LNET_NI_STATUS_UP;
256 else if (atomic_read(&ni->ni_fatal_error_on))
257 return LNET_NI_STATUS_DOWN;
258 else if (the_lnet.ln_routing && ni->ni_status)
259 return *ni->ni_status;
261 return LNET_NI_STATUS_UP;
265 lnet_ni_set_status(struct lnet_ni *ni, __u32 status)
270 update = lnet_ni_set_status_locked(ni, status);
276 static inline void lnet_md_wait_handling(struct lnet_libmd *md, int cpt)
278 wait_queue_head_t *wq = __var_waitqueue(md);
279 #if defined(HAVE_WAIT_BIT_QUEUE_ENTRY) || !defined(HAVE_WAIT_VAR_EVENT)
280 struct wait_bit_queue_entry entry;
281 wait_queue_entry_t *wqe = &entry.wq_entry;
283 struct wait_bit_queue entry;
284 wait_queue_entry_t *wqe = &entry.wait;
286 init_wait_var_entry(&entry, md, 0);
287 prepare_to_wait_event(wq, wqe, TASK_IDLE);
288 if (md->md_flags & LNET_MD_FLAG_HANDLING) {
289 /* Race with unlocked call to ->md_handler.
290 * It is safe to drop the res_lock here as the
291 * caller has only just claimed it.
293 lnet_res_unlock(cpt);
295 /* Cannot check md now, it might be freed. Caller
296 * must reclaim reference and check.
300 finish_wait(wq, wqe);
304 lnet_md_free(struct lnet_libmd *md)
308 LASSERTF(md->md_rspt_ptr == NULL, "md %p rsp %p\n", md, md->md_rspt_ptr);
310 size = offsetof(struct lnet_libmd, md_kiov[md->md_niov]);
312 if (size <= LNET_SMALL_MD_SIZE) {
313 LIBCFS_MEM_MSG(md, size, "slab-freed");
314 kmem_cache_free(lnet_small_mds_cachep, md);
316 LIBCFS_FREE(md, size);
320 struct lnet_libhandle *lnet_res_lh_lookup(struct lnet_res_container *rec,
322 void lnet_res_lh_initialize(struct lnet_res_container *rec,
323 struct lnet_libhandle *lh);
325 lnet_res_lh_invalidate(struct lnet_libhandle *lh)
327 /* ALWAYS called with resource lock held */
328 /* NB: cookie is still useful, don't reset it */
329 list_del(&lh->lh_hash_chain);
333 lnet_md2handle(struct lnet_handle_md *handle, struct lnet_libmd *md)
335 handle->cookie = md->md_lh.lh_cookie;
338 static inline struct lnet_libmd *
339 lnet_handle2md(struct lnet_handle_md *handle)
341 /* ALWAYS called with resource lock held */
342 struct lnet_libhandle *lh;
345 cpt = lnet_cpt_of_cookie(handle->cookie);
346 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
351 return lh_entry(lh, struct lnet_libmd, md_lh);
354 static inline struct lnet_libmd *
355 lnet_wire_handle2md(struct lnet_handle_wire *wh)
357 /* ALWAYS called with resource lock held */
358 struct lnet_libhandle *lh;
361 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
364 cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
365 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
366 wh->wh_object_cookie);
370 return lh_entry(lh, struct lnet_libmd, md_lh);
374 lnet_peer_net_addref_locked(struct lnet_peer_net *lpn)
376 atomic_inc(&lpn->lpn_refcount);
379 extern void lnet_destroy_peer_net_locked(struct lnet_peer_net *lpn);
382 lnet_peer_net_decref_locked(struct lnet_peer_net *lpn)
384 if (atomic_dec_and_test(&lpn->lpn_refcount))
385 lnet_destroy_peer_net_locked(lpn);
389 lnet_peer_addref_locked(struct lnet_peer *lp)
391 atomic_inc(&lp->lp_refcount);
394 extern void lnet_destroy_peer_locked(struct lnet_peer *lp);
397 lnet_peer_decref_locked(struct lnet_peer *lp)
399 if (atomic_dec_and_test(&lp->lp_refcount))
400 lnet_destroy_peer_locked(lp);
404 lnet_peer_ni_addref_locked(struct lnet_peer_ni *lp)
406 kref_get(&lp->lpni_kref);
409 extern void lnet_destroy_peer_ni_locked(struct kref *ref);
412 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
414 kref_put(&lp->lpni_kref, lnet_destroy_peer_ni_locked);
418 lnet_isrouter(struct lnet_peer_ni *lpni)
420 return lpni->lpni_peer_net->lpn_peer->lp_rtr_refcount != 0;
424 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
426 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
427 LASSERT(*ni->ni_refs[cpt] >= 0);
429 (*ni->ni_refs[cpt])++;
433 lnet_ni_addref(struct lnet_ni *ni)
436 lnet_ni_addref_locked(ni, 0);
441 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
443 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
444 LASSERT(*ni->ni_refs[cpt] > 0);
446 (*ni->ni_refs[cpt])--;
450 lnet_ni_decref(struct lnet_ni *ni)
453 lnet_ni_decref_locked(ni, 0);
457 static inline struct lnet_msg *
460 struct lnet_msg *msg;
462 msg = kmem_cache_zalloc(lnet_msg_cachep, GFP_NOFS);
468 lnet_msg_free(struct lnet_msg *msg)
470 LASSERT(!msg->msg_onactivelist);
471 kmem_cache_free(lnet_msg_cachep, msg);
474 static inline struct lnet_rsp_tracker *
475 lnet_rspt_alloc(int cpt)
477 struct lnet_rsp_tracker *rspt;
479 rspt = kmem_cache_zalloc(lnet_rspt_cachep, GFP_NOFS);
482 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc++;
483 lnet_net_unlock(cpt);
485 LIBCFS_ALLOC_POST(rspt, sizeof(*rspt), "alloc");
490 lnet_rspt_free(struct lnet_rsp_tracker *rspt, int cpt)
492 LIBCFS_FREE_PRE(rspt, sizeof(*rspt), "free");
493 kmem_cache_free(lnet_rspt_cachep, rspt);
495 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc--;
496 lnet_net_unlock(cpt);
499 void lnet_ni_free(struct lnet_ni *ni);
500 void lnet_net_free(struct lnet_net *net);
503 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
506 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
509 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
511 int lnet_ni_add_interface(struct lnet_ni *ni, char *iface);
514 lnet_nid2peerhash(struct lnet_nid *nid)
519 for (i = 0; i < 4; i++)
520 h = cfs_hash_32(nid->nid_addr[i]^h, 32);
521 return cfs_hash_32(LNET_NID_NET(nid) ^ h, LNET_PEER_HASH_BITS);
524 static inline struct list_head *
525 lnet_net2rnethash(__u32 net)
527 return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
529 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
532 static inline void lnet_hdr_from_nid4(struct lnet_hdr *hdr,
533 const struct lnet_hdr_nid4 *vhdr)
535 const struct _lnet_hdr_nid4 *hdr_nid4 = (void *)vhdr;
537 lnet_nid4_to_nid(le64_to_cpu(hdr_nid4->dest_nid), &hdr->dest_nid);
538 lnet_nid4_to_nid(le64_to_cpu(hdr_nid4->src_nid), &hdr->src_nid);
539 hdr->dest_pid = le32_to_cpu(hdr_nid4->dest_pid);
540 hdr->src_pid = le32_to_cpu(hdr_nid4->src_pid);
541 hdr->type = le32_to_cpu(hdr_nid4->type);
542 hdr->payload_length = le32_to_cpu(hdr_nid4->payload_length);
544 hdr->msg = hdr_nid4->msg;
547 static inline void lnet_hdr_to_nid4(const struct lnet_hdr *hdr,
548 struct lnet_hdr_nid4 *vhdr)
550 struct _lnet_hdr_nid4 *hdr_nid4 = (void *)vhdr;
552 hdr_nid4->dest_nid = cpu_to_le64(lnet_nid_to_nid4(&hdr->dest_nid));
553 hdr_nid4->src_nid = cpu_to_le64(lnet_nid_to_nid4(&hdr->src_nid));
554 hdr_nid4->dest_pid = cpu_to_le32(hdr->dest_pid);
555 hdr_nid4->src_pid = cpu_to_le32(hdr->src_pid);
556 hdr_nid4->type = cpu_to_le32(hdr->type);
557 hdr_nid4->payload_length = cpu_to_le32(hdr->payload_length);
559 hdr_nid4->msg = hdr->msg;
562 static inline void lnet_hdr_from_nid16(struct lnet_hdr *hdr,
563 const struct lnet_hdr_nid16 *vhdr)
565 const struct lnet_hdr *hdr16 = (void *)vhdr;
567 hdr->dest_nid = hdr16->dest_nid;
568 hdr->src_nid = hdr16->src_nid;
569 hdr->dest_pid = le32_to_cpu(hdr16->dest_pid);
570 hdr->src_pid = le32_to_cpu(hdr16->src_pid);
571 hdr->type = le32_to_cpu(hdr16->type);
572 hdr->payload_length = le32_to_cpu(hdr16->payload_length);
575 static inline void lnet_hdr_to_nid16(const struct lnet_hdr *hdr,
576 struct lnet_hdr_nid16 *vhdr)
578 struct lnet_hdr *hdr16 = (void *)vhdr;
580 hdr16->dest_nid = hdr->dest_nid;
581 hdr16->src_nid = hdr->src_nid;
582 hdr16->dest_pid = cpu_to_le32(hdr->dest_pid);
583 hdr16->src_pid = cpu_to_le32(hdr->src_pid);
584 hdr16->type = cpu_to_le32(hdr->type);
585 hdr16->payload_length = cpu_to_le32(hdr->payload_length);
588 extern const struct lnet_lnd the_lolnd;
589 extern int avoid_asym_router_failure;
591 extern unsigned int lnet_nid_cpt_hash(struct lnet_nid *nid,
592 unsigned int number);
593 extern int lnet_cpt_of_nid_locked(struct lnet_nid *nid, struct lnet_ni *ni);
594 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
595 extern int lnet_nid2cpt(struct lnet_nid *nid, struct lnet_ni *ni);
596 extern struct lnet_ni *lnet_nid_to_ni_locked(struct lnet_nid *nid, int cpt);
597 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
598 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
599 extern struct lnet_ni *lnet_nid_to_ni_addref(struct lnet_nid *nid);
600 struct lnet_net *lnet_get_net_locked(__u32 net_id);
602 int lnet_lib_init(void);
603 void lnet_lib_exit(void);
604 void lnet_router_exit(void);
606 extern unsigned int lnet_response_tracking;
607 extern unsigned lnet_transaction_timeout;
608 extern unsigned lnet_retry_count;
609 extern unsigned int lnet_lnd_timeout;
610 extern unsigned int lnet_numa_range;
611 extern unsigned int lnet_health_sensitivity;
612 extern unsigned int lnet_recovery_interval;
613 extern unsigned int lnet_recovery_limit;
614 extern unsigned int lnet_peer_discovery_disabled;
615 extern unsigned int lnet_drop_asym_route;
616 extern unsigned int lnet_max_recovery_ping_interval;
617 extern unsigned int lnet_max_recovery_ping_count;
618 extern unsigned int router_sensitivity_percentage;
619 extern int alive_router_check_interval;
620 extern int live_router_check_interval;
621 extern int dead_router_check_interval;
622 extern int portal_rotor;
623 extern int lock_prim_nid;
625 void lnet_mt_event_handler(struct lnet_event *event);
627 int lnet_notify(struct lnet_ni *ni, struct lnet_nid *peer, bool alive,
628 bool reset, time64_t when);
629 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
631 int lnet_add_route(__u32 net, __u32 hops, struct lnet_nid *gateway,
632 __u32 priority, __u32 sensitivity);
633 int lnet_del_route(__u32 net, struct lnet_nid *gw_nid);
634 void lnet_move_route(struct lnet_route *route, struct lnet_peer *lp,
635 struct list_head *rt_list);
636 void lnet_destroy_routes(void);
637 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
638 lnet_nid_t *gateway, __u32 *alive, __u32 *priority,
640 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
641 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
642 struct lnet_ni *prev);
643 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
644 int lnet_get_net_healthv_locked(struct lnet_net *net);
646 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
647 struct libcfs_ioctl_hdr __user *uparam);
648 extern int lnet_get_peer_list(__u32 *countp, __u32 *sizep,
649 struct lnet_process_id __user *ids);
650 extern void lnet_peer_ni_set_healthv(lnet_nid_t nid, int value, bool all);
651 extern void lnet_peer_ni_add_to_recoveryq_locked(struct lnet_peer_ni *lpni,
652 struct list_head *queue,
654 extern int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni,
655 struct lnet_nid *nid);
656 extern void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
657 extern int lnet_peer_del_pref_nid(struct lnet_peer_ni *lpni,
658 struct lnet_nid *nid);
659 void lnet_peer_ni_set_selection_priority(struct lnet_peer_ni *lpni,
661 extern void lnet_ni_add_to_recoveryq_locked(struct lnet_ni *ni,
662 struct list_head *queue,
665 void lnet_router_debugfs_init(void);
666 void lnet_router_debugfs_fini(void);
667 int lnet_rtrpools_alloc(int im_a_router);
668 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
669 int lnet_rtrpools_adjust(int tiny, int small, int large);
670 int lnet_rtrpools_enable(void);
671 void lnet_rtrpools_disable(void);
672 void lnet_rtrpools_free(int keep_pools);
673 void lnet_rtr_transfer_to_peer(struct lnet_peer *src,
674 struct lnet_peer *target);
675 struct lnet_remotenet *lnet_find_rnet_locked(__u32 net);
676 int lnet_dyn_add_net(struct lnet_ioctl_config_data *conf);
677 int lnet_dyn_del_net(__u32 net);
678 int lnet_dyn_add_ni(struct lnet_ioctl_config_ni *conf, u32 net,
679 struct lnet_ioctl_config_lnd_tunables *tun);
680 int lnet_dyn_del_ni(struct lnet_nid *nid);
681 int lnet_clear_lazy_portal(struct lnet_ni *ni, int portal, char *reason);
682 struct lnet_net *lnet_get_net_locked(__u32 net_id);
683 void lnet_net_clr_pref_rtrs(struct lnet_net *net);
684 int lnet_net_add_pref_rtr(struct lnet_net *net, struct lnet_nid *gw_nid);
686 int lnet_islocalnid(struct lnet_nid *nid);
687 int lnet_islocalnet(__u32 net);
688 int lnet_islocalnet_locked(__u32 net);
690 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
691 unsigned int offset, unsigned int mlen);
692 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
693 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
694 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
695 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
697 void lnet_prep_send(struct lnet_msg *msg, int type,
698 struct lnet_processid *target, unsigned int offset,
700 int lnet_send(struct lnet_nid *nid, struct lnet_msg *msg,
701 struct lnet_nid *rtr_nid);
702 int lnet_send_ping(struct lnet_nid *dest_nid, struct lnet_handle_md *mdh,
703 int bytes, void *user_ptr, lnet_handler_t handler,
705 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
706 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
707 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
708 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
710 struct list_head **lnet_create_array_of_queues(void);
712 /* portals functions */
713 /* portals attributes */
715 lnet_ptl_is_lazy(struct lnet_portal *ptl)
717 return !!(ptl->ptl_options & LNET_PTL_LAZY);
721 lnet_ptl_is_unique(struct lnet_portal *ptl)
723 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
727 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
729 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
733 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
735 ptl->ptl_options |= opt;
739 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
741 ptl->ptl_options &= ~opt;
744 /* match-table functions */
745 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
746 struct lnet_processid *id, __u64 mbits);
747 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
748 struct lnet_processid *id,
749 __u64 mbits, __u64 ignore_bits,
750 enum lnet_ins_pos pos);
751 int lnet_mt_match_md(struct lnet_match_table *mtable,
752 struct lnet_match_info *info, struct lnet_msg *msg);
754 /* portals match/attach functions */
755 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
756 struct list_head *matches, struct list_head *drops);
757 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
758 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
760 /* initialized and finalize portals */
761 int lnet_portals_create(void);
762 void lnet_portals_destroy(void);
764 /* message functions */
765 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
766 struct lnet_nid *fromnid, void *private, int rdma_req);
767 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
768 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
770 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
771 int delayed, unsigned int offset, unsigned int mlen,
773 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
774 int delayed, unsigned int offset,
775 unsigned int mlen, unsigned int rlen);
776 void lnet_ni_send(struct lnet_ni *ni, struct lnet_msg *msg);
778 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
779 struct lnet_msg *get_msg);
780 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
782 void lnet_detach_rsp_tracker(struct lnet_libmd *md, int cpt);
783 void lnet_clean_zombie_rstqs(void);
785 bool lnet_md_discarded(struct lnet_libmd *md);
786 void lnet_finalize(struct lnet_msg *msg, int rc);
787 bool lnet_send_error_simulation(struct lnet_msg *msg,
788 enum lnet_msg_hstatus *hstatus);
789 void lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni);
791 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
792 unsigned int nob, __u32 msg_type);
793 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
794 void lnet_recv_delayed_msg_list(struct list_head *head);
796 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
797 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
798 void lnet_msg_containers_destroy(void);
799 int lnet_msg_containers_create(void);
801 char *lnet_health_error2str(enum lnet_msg_hstatus hstatus);
802 char *lnet_msgtyp2str(int type);
803 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
805 /** \addtogroup lnet_fault_simulation @{ */
807 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
808 int lnet_fault_init(void);
809 void lnet_fault_fini(void);
811 bool lnet_drop_rule_match(struct lnet_hdr *hdr, struct lnet_nid *local_nid,
812 enum lnet_msg_hstatus *hstatus);
814 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
815 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
816 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
817 struct lnet_fault_stat *stat);
818 void lnet_delay_rule_reset(void);
819 void lnet_delay_rule_check(void);
820 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
822 /** @} lnet_fault_simulation */
824 void lnet_counters_get_common(struct lnet_counters_common *common);
825 int lnet_counters_get(struct lnet_counters *counters);
826 void lnet_counters_reset(void);
828 lnet_ni_set_sel_priority_locked(struct lnet_ni *ni, __u32 priority)
830 ni->ni_sel_priority = priority;
834 lnet_net_set_sel_priority_locked(struct lnet_net *net, __u32 priority)
836 net->net_sel_priority = priority;
839 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
840 unsigned int lnet_kiov_nob(unsigned int niov, struct bio_vec *iov);
841 int lnet_extract_kiov(int dst_niov, struct bio_vec *dst,
842 int src_niov, struct bio_vec *src,
843 unsigned int offset, unsigned int len);
845 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
846 unsigned int doffset,
847 unsigned int nsiov, struct kvec *siov,
848 unsigned int soffset, unsigned int nob);
849 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
850 unsigned int iovoffset,
851 unsigned int nkiov, struct bio_vec *kiov,
852 unsigned int kiovoffset, unsigned int nob);
853 void lnet_copy_iov2kiov(unsigned int nkiov, struct bio_vec *kiov,
854 unsigned int kiovoffset,
855 unsigned int niov, struct kvec *iov,
856 unsigned int iovoffset, unsigned int nob);
857 void lnet_copy_kiov2kiov(unsigned int ndkiov, struct bio_vec *dkiov,
858 unsigned int doffset,
859 unsigned int nskiov, struct bio_vec *skiov,
860 unsigned int soffset, unsigned int nob);
863 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
864 unsigned int nsiov, struct bio_vec *skiov,
865 unsigned int soffset, unsigned int nob)
867 struct kvec diov = { .iov_base = dest, .iov_len = dlen };
869 lnet_copy_kiov2iov(1, &diov, doffset,
870 nsiov, skiov, soffset, nob);
874 lnet_copy_flat2kiov(unsigned int ndiov, struct bio_vec *dkiov,
875 unsigned int doffset, int slen, void *src,
876 unsigned int soffset, unsigned int nob)
878 struct kvec siov = { .iov_base = src, .iov_len = slen };
879 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
880 1, &siov, soffset, nob);
883 void lnet_me_unlink(struct lnet_me *me);
885 void lnet_md_unlink(struct lnet_libmd *md);
886 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_event *ev);
887 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
888 struct page *lnet_get_first_page(struct lnet_libmd *md, unsigned int offset);
889 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
891 unsigned int lnet_get_lnd_timeout(void);
892 void lnet_register_lnd(const struct lnet_lnd *lnd);
893 void lnet_unregister_lnd(const struct lnet_lnd *lnd);
895 struct socket *lnet_connect(struct lnet_nid *peer_nid, int interface,
896 struct sockaddr *peeraddr, struct net *ns);
897 void lnet_connect_console_error(int rc, struct lnet_nid *peer_nid,
898 struct sockaddr *sa);
899 int lnet_count_acceptor_nets(void);
900 int lnet_acceptor_timeout(void);
901 int lnet_acceptor_port(void);
902 int lnet_acceptor_start(void);
903 void lnet_acceptor_stop(void);
905 struct lnet_inetdev {
917 char li_name[IFNAMSIZ];
920 int lnet_inet_enumerate(struct lnet_inetdev **dev_list, struct net *ns,
922 int lnet_inet_select(struct lnet_ni *ni, struct lnet_inetdev *ifaces,
925 void lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
926 void lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
927 int lnet_sock_getaddr(struct socket *socket, bool remote,
928 struct sockaddr_storage *peer);
929 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
930 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
932 struct socket *lnet_sock_listen(int port, int backlog,
934 struct socket *lnet_sock_connect(int interface, int local_port,
935 struct sockaddr *peeraddr,
938 int lnet_peers_start_down(void);
939 int lnet_peer_buffer_credits(struct lnet_net *net);
940 void lnet_consolidate_routes_locked(struct lnet_peer *orig_lp,
941 struct lnet_peer *new_lp);
942 void lnet_router_discovery_complete(struct lnet_peer *lp);
943 void lnet_router_discovery_ping_reply(struct lnet_peer *lp,
944 struct lnet_ping_buffer *pbuf);
946 int lnet_monitor_thr_start(void);
947 void lnet_monitor_thr_stop(void);
949 bool lnet_router_checker_active(void);
950 void lnet_check_routers(void);
951 void lnet_wait_router_start(void);
952 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
954 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
955 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int bytes, gfp_t gfp);
956 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
958 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
960 atomic_inc(&pbuf->pb_refcnt);
963 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
965 if (atomic_dec_and_test(&pbuf->pb_refcnt)) {
966 wake_up_var(&pbuf->pb_refcnt);
967 lnet_ping_buffer_free(pbuf);
971 struct lnet_ping_iter {
972 struct lnet_ping_info *pinfo;
976 u32 *ping_iter_first(struct lnet_ping_iter *pi, struct lnet_ping_buffer *pbuf,
977 struct lnet_nid *nid);
978 u32 *ping_iter_next(struct lnet_ping_iter *pi, struct lnet_nid *nid);
979 int ping_info_count_entries(struct lnet_ping_buffer *pbuf);
981 static inline int lnet_push_target_resize_needed(void)
983 return the_lnet.ln_push_target->pb_nbytes < the_lnet.ln_push_target_nbytes;
986 int lnet_push_target_resize(void);
987 int lnet_push_target_post(struct lnet_ping_buffer *pbuf,
988 struct lnet_handle_md *mdh);
989 void lnet_peer_push_event(struct lnet_event *ev);
991 int lnet_parse_ip2nets(const char **networksp, const char *ip2nets);
992 int lnet_parse_routes(const char *route_str, int *im_a_router);
993 int lnet_parse_networks(struct list_head *nilist, const char *networks);
994 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
995 struct lnet_net **net);
996 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
997 void lnet_incr_dlc_seq(void);
998 __u32 lnet_get_dlc_seq_locked(void);
1000 struct lnet_peer_net *lnet_get_next_peer_net_locked(struct lnet_peer *lp,
1002 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
1003 struct lnet_peer_net *peer_net,
1004 struct lnet_peer_ni *prev);
1005 struct lnet_peer_ni *lnet_peerni_by_nid_locked(struct lnet_nid *nid,
1006 struct lnet_nid *pref,
1008 struct lnet_peer_ni *lnet_nid2peerni_ex(struct lnet_nid *nid);
1009 struct lnet_peer_ni *lnet_peer_ni_get_locked(struct lnet_peer *lp,
1010 struct lnet_nid *nid);
1011 struct lnet_peer_ni *lnet_peer_ni_find_locked(struct lnet_nid *nid);
1012 struct lnet_peer *lnet_find_peer(struct lnet_nid *nid);
1013 void lnet_peer_net_added(struct lnet_net *net);
1014 void lnet_peer_primary_nid_locked(struct lnet_nid *nid,
1015 struct lnet_nid *result);
1016 int lnet_discover_peer_locked(struct lnet_peer_ni *lpni, int cpt, bool block);
1017 void lnet_peer_queue_message(struct lnet_peer *lp, struct lnet_msg *msg);
1018 int lnet_peer_discovery_start(void);
1019 void lnet_peer_discovery_stop(void);
1020 void lnet_push_update_to_peers(int force);
1021 void lnet_peer_tables_cleanup(struct lnet_net *net);
1022 void lnet_peer_uninit(void);
1023 int lnet_peer_tables_create(void);
1024 void lnet_debug_peer(struct lnet_nid *nid);
1025 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
1027 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni,
1028 struct lnet_nid *nid);
1029 int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, struct lnet_nid *nid);
1030 void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
1031 bool lnet_peer_is_pref_rtr_locked(struct lnet_peer_ni *lpni,
1032 struct lnet_nid *gw_nid);
1033 void lnet_peer_clr_pref_rtrs(struct lnet_peer_ni *lpni);
1034 int lnet_peer_add_pref_rtr(struct lnet_peer_ni *lpni, struct lnet_nid *nid);
1035 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni,
1036 struct lnet_nid *nid);
1037 int lnet_user_add_peer_ni(struct lnet_nid *key_nid, struct lnet_nid *nid,
1038 bool mr, bool lock_prim);
1039 int lnet_del_peer_ni(struct lnet_nid *key_nid, struct lnet_nid *nid,
1041 int lnet_get_peer_info(struct lnet_ioctl_peer_cfg *cfg, void __user *bulk);
1042 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
1043 char alivness[LNET_MAX_STR_LEN],
1044 __u32 *cpt_iter, __u32 *refcount,
1045 __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
1046 __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
1047 __u32 *peer_tx_qnob);
1048 int lnet_get_peer_ni_hstats(struct lnet_ioctl_peer_ni_hstats *stats);
1051 lnet_peer_net_set_sel_priority_locked(struct lnet_peer_net *lpn, __u32 priority)
1053 lpn->lpn_sel_priority = priority;
1057 static inline struct lnet_peer_net *
1058 lnet_find_peer_net_locked(struct lnet_peer *peer, __u32 net_id)
1060 struct lnet_peer_net *peer_net;
1062 list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
1063 if (peer_net->lpn_net_id == net_id)
1071 lnet_peer_is_multi_rail(struct lnet_peer *lp)
1073 if (lp->lp_state & LNET_PEER_MULTI_RAIL)
1079 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
1081 if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
1087 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
1089 return nid_same(&lpni->lpni_nid,
1090 &lpni->lpni_peer_net->lpn_peer->lp_primary_nid);
1093 bool lnet_peer_is_uptodate(struct lnet_peer *lp);
1094 bool lnet_peer_is_uptodate_locked(struct lnet_peer *lp);
1095 bool lnet_is_discovery_disabled(struct lnet_peer *lp);
1096 bool lnet_is_discovery_disabled_locked(struct lnet_peer *lp);
1097 bool lnet_peer_gw_discovery(struct lnet_peer *lp);
1100 lnet_peer_needs_push(struct lnet_peer *lp)
1102 if (!(lp->lp_state & LNET_PEER_MULTI_RAIL))
1104 if (lp->lp_state & LNET_PEER_MARK_DELETED)
1106 if (lp->lp_state & LNET_PEER_FORCE_PUSH)
1108 if (lp->lp_state & LNET_PEER_NO_DISCOVERY)
1110 /* if discovery is not enabled then no need to push */
1111 if (lnet_peer_discovery_disabled)
1113 if (lp->lp_node_seqno < atomic_read(&the_lnet.ln_ping_target_seqno))
1118 static inline unsigned int
1119 lnet_get_next_recovery_ping(unsigned int ping_count, time64_t now)
1121 unsigned int interval;
1123 /* lnet_max_recovery_interval <= 2^lnet_max_recovery_ping_count */
1124 if (ping_count > lnet_max_recovery_ping_count)
1125 interval = lnet_max_recovery_ping_interval;
1127 interval = 1 << ping_count;
1129 return now + interval;
1133 lnet_peer_ni_set_next_ping(struct lnet_peer_ni *lpni, time64_t now)
1135 lpni->lpni_next_ping =
1136 lnet_get_next_recovery_ping(lpni->lpni_ping_count, now);
1140 lnet_ni_set_next_ping(struct lnet_ni *ni, time64_t now)
1142 ni->ni_next_ping = lnet_get_next_recovery_ping(ni->ni_ping_count, now);
1146 * A peer NI is alive if it satisfies the following two conditions:
1147 * 1. peer NI health >= LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage
1148 * 2. the cached NI status received when we discover the peer is UP
1151 lnet_is_peer_ni_alive(struct lnet_peer_ni *lpni)
1153 bool halive = false;
1155 halive = (atomic_read(&lpni->lpni_healthv) >=
1156 (LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage / 100));
1158 return halive && lpni->lpni_ns_status == LNET_NI_STATUS_UP;
1162 lnet_update_peer_net_healthv(struct lnet_peer_ni *lpni)
1164 struct lnet_peer_net *lpn;
1165 int best_healthv = 0;
1167 lpn = lpni->lpni_peer_net;
1169 list_for_each_entry(lpni, &lpn->lpn_peer_nis, lpni_peer_nis) {
1170 int lpni_healthv = atomic_read(&lpni->lpni_healthv);
1171 if (best_healthv < lpni_healthv)
1172 best_healthv = lpni_healthv;
1175 lpn->lpn_healthv = best_healthv;
1179 lnet_set_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1181 if (atomic_read(&lpni->lpni_healthv) == value)
1183 atomic_set(&lpni->lpni_healthv, value);
1184 lnet_update_peer_net_healthv(lpni);
1188 lnet_atomic_add_unless_max(atomic_t *v, int a, int u)
1190 int c = atomic_read(v);
1203 old = atomic_cmpxchg(v, c, m);
1219 lnet_dec_healthv_locked(atomic_t *healthv, int sensitivity)
1221 int h = atomic_read(healthv);
1226 if (h < sensitivity)
1231 return (atomic_xchg(healthv, h) != h);
1235 lnet_dec_lpni_healthv_locked(struct lnet_peer_ni *lpni)
1237 /* If there is a health sensitivity in the peer then use that
1238 * instead of the globally set one.
1239 * only adjust the net health if the lpni health value changed
1241 if (lnet_dec_healthv_locked(&lpni->lpni_healthv,
1242 lpni->lpni_peer_net->lpn_peer->lp_health_sensitivity ? :
1243 lnet_health_sensitivity)) {
1244 lnet_update_peer_net_healthv(lpni);
1249 lnet_inc_lpni_healthv_locked(struct lnet_peer_ni *lpni)
1251 /* If there is a health sensitivity in the peer then use that
1252 * instead of the globally set one.
1253 * only adjust the net health if the lpni health value changed
1255 if (lnet_atomic_add_unless_max(&lpni->lpni_healthv,
1256 lpni->lpni_peer_net->lpn_peer->lp_health_sensitivity ? :
1257 lnet_health_sensitivity,
1258 LNET_MAX_HEALTH_VALUE)) {
1259 lnet_update_peer_net_healthv(lpni);
1264 lnet_inc_healthv(atomic_t *healthv, int value)
1266 lnet_atomic_add_unless_max(healthv, value, LNET_MAX_HEALTH_VALUE);
1270 lnet_get_list_len(struct list_head *list)
1272 struct list_head *l;
1275 list_for_each(l, list)
1281 void lnet_incr_stats(struct lnet_element_stats *stats,
1282 enum lnet_msg_type msg_type,
1283 enum lnet_stats_type stats_type);
1285 __u32 lnet_sum_stats(struct lnet_element_stats *stats,
1286 enum lnet_stats_type stats_type);
1288 void lnet_usr_translate_stats(struct lnet_ioctl_element_msg_stats *msg_stats,
1289 struct lnet_element_stats *stats);
1292 lnet_set_route_aliveness(struct lnet_route *route, bool alive)
1294 bool old = atomic_xchg(&route->lr_alive, alive);
1297 CERROR("route to %s through %s has gone from %s to %s\n",
1298 libcfs_net2str(route->lr_net),
1299 libcfs_nidstr(&route->lr_gateway->lp_primary_nid),
1300 old ? "up" : "down",
1301 alive ? "up" : "down");
1303 void lnet_update_ping_buffer(void);